The style that I use to write docstrings has changed over time, so that there are multiple styles at once throughout the code at present.
Ideally, the code documentation should be rendered stylistically homogeneous.
On this note, it might be worth settling on a style for the project moving forward, both for the docstrings and the Python code developed.
The official Python documents are 1 and 2 for docstrings and code respectively.
Lately though I have actually been using the Google Python style guide 3, which covers pretty much everything. The only thing I disagree with it is over the linting tool to be used. I find pylint needlessly opinionated in some things and would be inclined more towards flake8 instead.
@enridaga opinions are welcome!
The style that I use to write docstrings has changed over time, so that there are multiple styles at once throughout the code at present.
Ideally, the code documentation should be rendered stylistically homogeneous.
On this note, it might be worth settling on a style for the project moving forward, both for the docstrings and the Python code developed.
The official Python documents are 1 and 2 for docstrings and code respectively.
Lately though I have actually been using the Google Python style guide 3, which covers pretty much everything. The only thing I disagree with it is over the linting tool to be used. I find
pylintneedlessly opinionated in some things and would be inclined more towardsflake8instead.@enridaga opinions are welcome!