Set max doc length to 75 for python/dolfinx/ and python/demo/
#3706
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
garth-wells
reviewed
Apr 16, 2025
| @@ -0,0 +1,5 @@ | |||
| [tool.ruff] | |||
| extend = "../pyproject.toml" | |||
There was a problem hiding this comment.
Tells ruff to pick up the config file given by the relative path and extend it with the definitions in this file. Therefore the doc line formatting does not get applied to for example python/test
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Sphinx requires max line length of 79 see https://documentation-style-guide-sphinx.readthedocs.io/en/latest/style-guide.html#line-length. Dolfinx seems to be already mostly formatted with
max-doc-length = 75- this is however not checked with ruff and causes reformatting issues when the doc strings are changed over time.Proposes to enable a ruff check for the specified doc string line length for the documentation relevant Python directories.