Other Docstring improvements #998
Open
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 ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #998 +/- ##
==========================================
- Coverage 87.25% 87.24% -0.01%
==========================================
Files 9 9
Lines 4928 4932 +4
==========================================
+ Hits 4300 4303 +3
- Misses 628 629 +1 ☔ View full report in Codecov by Sentry. |
MarcSkovMadsen
commented
Dec 29, 2024
| default, doc, and precedence all default to None, which allows | ||
| inheritance of Parameter slots (attributes) from the owning-class' | ||
| class hierarchy (see ParameterizedMetaclass). | ||
| def __init__( # pylint: disable-msg=R0913 |
There was a problem hiding this comment.
I would have like to type annotate Parameter.__init__ but because of the overloading and use of Undefined for example the type annotation of doc would become Union[str, None, _Undefined]. I'm not really sure that is helpful to users? But maybe we should define DocType=Union[str, None, _Undefined] and then use that in the ~40 places we need to use that type?
…/holoviz/param into enhancements/docs-rest
Co-authored-by: Maxime Liquet <[email protected]>
Co-authored-by: Maxime Liquet <[email protected]>
Co-authored-by: Maxime Liquet <[email protected]>
…/holoviz/param into enhancement/docs-param-namespace
…/holoviz/param into enhancements/docs-rest
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.
Starts from #997. Please review that one first.