Should the Document your code section in Python Coding Conventions be moved to Documentation?

choderalab / software-development

A primer on software development best practices for computational chemistry

255 stars 76 forks source link

Should the Document your code section in Python Coding Conventions be moved to Documentation? #47

Open earosenz opened 7 years ago

earosenz commented 7 years ago

I agree with mentioning the docstrings Python convention in the Python Coding Conventions section, but I wonder if it wouldn't be better to treat the subject more extensively in the Documentation section and keep the Conventions one short and sweet.