search

ChrisCScott / forecaster

A personal finances forecasting tool for Canadian retirement planning
Other
1 stars 2 forks source link

Update docstrings to resolve Sphinx warnings #35

Closed ChrisCScott closed 6 years ago

ChrisCScott commented 6 years ago

Docstrings for this project should comply with Google's Python style guide, as parsed by Sphinx's Napoleon extension.

Much of the existing codebase has comments that largely follow these conventions but add unexpected indentation and don't separate paragraphs with blank lines, which makes the documentation hard to read when parsed.

Consider whether :class: or :obj: annotations ought to be added for completeness, at least for internal class references. (See this reference for examples.)

ChrisCScott commented 6 years ago

Current docstrings do not raise Sphinx warnings. Not sure which commit resolved this - likely one shortly after this issue was created.

We've elected not to add :class: or :obj: annotations at this time in the interest of readability.