Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Manually linewrap long docstrings. #241

Merged
merged 3 commits into from
Dec 24, 2023
Merged

Manually linewrap long docstrings. #241

merged 3 commits into from
Dec 24, 2023

Conversation

iancze
Copy link
Collaborator

@iancze iancze commented Dec 24, 2023

  • Manually line wrapped many docstrings to conform to 88 characters per line or less. This wasn't a shortcoming of napoleon (or more accurately, the 'Google' string style I've been using) but actually black. I thought black 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.

@iancze iancze merged commit 3070436 into main Dec 24, 2023
4 checks passed
@iancze iancze deleted the linebreaks branch December 24, 2023 02:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant