[too-many-positional-arguments doc] Add the main option to use, real example #9957
Conversation
This file contains 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
Pierre-Sassoulas
added
Documentation 📗
Skip news 🔇
Comment on lines
1
to
2
| [MESSAGES CONTROL] | ||
| disable=too-many-arguments |
There was a problem hiding this comment.
We could even remove that considering it's not going to raise now.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9957 /- ##
=======================================
Coverage 95.80% 95.80%
=======================================
Files 174 174
Lines 18940 18940
=======================================
Hits 18146 18146
Misses 794 794 |
jacobtylerwalls
previously approved these changes
Sep 24, 2024
Pierre-Sassoulas
force-pushed
the
better-doc-option-max-positional-args
branch
from
7d3c06b
to
01c559b
Compare
jacobtylerwalls
approved these changes
Sep 24, 2024
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.
Type of Changes
Description
Permits to see the option you have to change when reading the doc (probably the next frontier in our doc, is documenting the option that affect each message). Also made the example more concrete, added the effect on the API, and removed the class construct.