Classes Docstrings

[Zarad1993]

Docstrings are missing in new clases and at the top of the file

[frangiz]

Hey, I can fix this if you want. Will fix a PR for you.

[Zarad1993]

@frangiz - That'll be great. Thanks

[demern]

Hey there--is this still an issue that you'd like folks to help out with? I see that a pull request was merged about a year ago, but looking at the project today I still see a bunch of methods in the 'dyc' classes themselves that are missing docstrings and getting picked up by the tool:

(dyc-venv) [ndemers@localhost dyc]$ dyc start
`dyc.yaml` Missing or Incorrectly formatted. USING default settings

Processing Methods



In file dyc/dyc/utils.py :

Do you want to document method list keywords: list of keywords like for python, func for go etc.? [y/N]: 


In file dyc/tests/test_utils.py :

Do you want to document method test_should_return_none_if_not_found? [y/N]: 
Do you want to document method test_tabs? [y/N]: 
Do you want to document method test_2_spaces? [y/N]: 
Do you want to document method test_falsy_value? [y/N]: 
Do you want to document method test_default_4_spaces? [y/N]: 
Do you want to document method test_existing_extension_valid? [y/N]: 
Do you want to document method test_non_existing_extension? [y/N]: 
Do you want to document method test_wrong_extension_type? [y/N]: 
(dyc-venv) [ndemers@localhost dyc]$ 

If so, let me know and I can take a stab at adding docstrings for the above methods so dyc gives clean output for the project sources.

[Zarad1993]

Hey @demern - Please go ahead with it. I don't think anyone is looking at this currently.

[Zarad1993]

If so, let me know and I can take a stab at adding docstrings for the above methods so dyc gives clean output for the project sources.

Good idea

[demern]

Hi @Zarad1993 - I've posted a PR for the new docstrings here: #61

I also filed a new issue for another bug I observed along the way: #62

[Zarad1993]

Thanks @demern - I will try to move the PR forward today/tomorrow max.
Your contribution is highly appreciated.

[AshirGuptash]

Hi @Zarad1993 , I'd like to contribute to this (for the classesBuilder() part). For this, what are you thinking for the format of a class docstring? Do we want something that has the parameters of the class itself (inheritance) or maybe the parameters of the init function?

[Zarad1993]

Yes, perhaps the parameters of the class inheritance would work perfectly.. We can iterate on it if you want too.

[AshirGuptash]

Sounds good, we can start with just inheritance arguments in the docstring, and add to afterward.

[AshirGuptash]

Hi @Zarad1993 , we sent a PR #68 . Can you review it when you get the chance? Thanks!

[Friendly-Banana]

@Zarad1993 This issue should be closed, right?