GH-137623: Use an AC decorator for docstring line length enforcement #137690
+569
−570
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
fbb070c to
37dbdf7
Compare
|
I'm not sure if this is a good approach. It's much harder to get list of exceptions.
You could document this list in the devguide, right? |
What are the use-cases for getting the list of too-long docstrings? If we are fixing/improving the docstrings, it could be better to remove a decorator in the same part of the same file, rather than looking in a random different file. A |
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.
After thinking about it, @serhiy-storchaka's suggestion to use a decorator seems a better approach. It keeps the information localised to where the problem is, rather than hiding it in
libclinic, which most contributors shouldn't need to worry about.Opening as draft to avoid review-request spam until ready for merge.
A