Add Docstring to Enum for Option descriptions, issue 1510 #1699
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
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #1699 +/- ##
==========================================
- Coverage 33.23% 33.23% -0.01%
==========================================
Files 95 95
Lines 18423 18424 +1
==========================================
Hits 6123 6123
- Misses 12300 12301 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
jdelucca
changed the title
BobDotCom
reviewed
Oct 17, 2022
BobDotCom
added
priority: low
Lulalaby
approved these changes
Oct 17, 2022
BobDotCom
approved these changes
Oct 18, 2022
Lulalaby
approved these changes
Oct 18, 2022
Dorukyum
approved these changes
Oct 18, 2022
|
Very cool. I'd appreciate it if you could add the hacktoberfest-accepted label, though I'm not totally sure if this project is doing hacktoberfest. |
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.
Summary
Hacktoberfest pull request.
For closing Issue #1510. Beyond adding small details to the docs, also adding docstrings to the Enum classes so that if an Option tries to reference them, it'll have a description by default, but also changing the Option behavior so that if the dev includes a description text when calling Option, the docstring from Enums won't override that description text.
Fixes this behavior ("No description provided"):
Information
examples, ...).
Checklist
type: ignorecomments were used, a comment is also left explaining why.