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

Clarify docstring length in CONTRIBUTING.rst #5198

Closed
tofu-rocketry opened this issue Nov 15, 2023 · 0 comments · Fixed by #5370
Closed

Clarify docstring length in CONTRIBUTING.rst #5198

tofu-rocketry opened this issue Nov 15, 2023 · 0 comments · Fixed by #5370
Labels
maintenance Low-impact maintenance activity

Comments

@tofu-rocketry
Copy link

Describe what maintenance you would like added.

This PR #4129 implies that you're settling on a docstring length of 75 to match numpy.

However, your CONTRIBUTING.rst says to follow PEP 8 and 72 char docstrings, but the docstring section refers you to the numpydoc Style Guide and so implicitly endorses 75 characters (as there's no exception from NumPy's line length).

Either the Coding Style section should go with 75 characters, or the Docstring section should list an exception from NumPy's standard.

Links to source code.

Coding Style section: https://github.com/pyvista/pyvista/blob/94c484c6a6a54b86704168a54666323234d7fdf5/CONTRIBUTING.rst#coding-style

Docstring section: https://github.com/pyvista/pyvista/blob/94c484c6a6a54b86704168a54666323234d7fdf5/CONTRIBUTING.rst#docstrings

Pseudocode or Screenshots

No response

@tofu-rocketry tofu-rocketry added the maintenance Low-impact maintenance activity label Nov 15, 2023
@tkoyama010 tkoyama010 linked a pull request Dec 20, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Low-impact maintenance activity
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant