Manually linewrap long docstrings. #241
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
napoleon
(or more accurately, the 'Google' string style I've been using) but actuallyblack
. I thoughtblack
would reflow docstrings by default, but actually that doesn't seem to be the case.Should address the horizontal scrolling issue mentioned in #235 (also an issue for reading docstrings on GitHub). With the reflowed lines, the 'Google' style and the 'NumPy' style actually look pretty similar. Here is the official comparison with an admonition that a project should stick with a single docstyle.
If we are going to stick to a recommended line length of 88 columns (black) for all
*.py
files, then NumPy style might have the slight edge in terms of readability, since most of our docstrings are long and have complex arg types like tensors. As long as the docs compile accurately this is a low priority issue, but worth thinking about which direction we want our docstrings to drift towards in the natural course of editing.Side note that Sphinx, even the latest v7, is terrible at giving useful errors on docstring formatting. Most of the errors raised during the docs build did not correspond to the site listed, but rather some other non-indented docstring in the same file.