glotzerlab / freud

Powerful, efficient particle trajectory analysis in scientific Python.
https://freud.readthedocs.io
BSD 3-Clause "New" or "Revised" License
280 stars 49 forks source link

Remove `noqa: E501` from docstrings #1292

Open joaander opened 2 weeks ago

joaander commented 2 weeks ago

Description

Remove noqa: E501 from docstrings and reformat them as needed. If it is not possible to reformat them, consider increasing the allowed line length.

Motivation and Context

Adding noqa: E501 ignores the rule for all lines in the docstring - essentially making the check useless for large sections of code that should be kept to the same line length: https://docs.astral.sh/ruff/rules/line-too-long/.