choderalab / software-development

A primer on software development best practices for computational chemistry
262 stars 78 forks source link

Docstring format recommendations #2

Closed pgrinaway closed 7 years ago

pgrinaway commented 7 years ago

I think it would be helpful to encourage:

Although I have personally favored the numpy style in the past, I actually think the numpy standard is harder to comply with, so it might be easier to generate docs with restructured text.

bas-rustenburg commented 7 years ago

I think we could view this as either part of documentation, or code style.

andrrizzi commented 7 years ago

Happy to help out.

andrrizzi commented 7 years ago

I wrote about this in #23 . I'll include a link to the how-to documentation article described by #16 when it'll be in. Feel free to reopen if you think the point needs to be expanded on that article!