fix: Allow autodoc functions to have no parameters #1072
Merged
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
mofojed
requested changes
Dec 19, 2024
sphinx_ext/deephaven_autodoc.py
Outdated
| @@ -46,31 +46,37 @@ class SignatureData(TypedDict): | |||
|
|
|||
| AUTOFUNCTION_COMMENT_PREFIX = "AutofunctionCommentPrefix:" | |||
|
|
|||
| UNDOCUMENTED_PARAMS = {"*"} | |||
There was a problem hiding this comment.
I imagine this is the param that separates positional args from keyword args? May want to add "/" to this list as well then, that's used in a couple spots. Comment would be useful here as well.
mofojed
approved these changes
Dec 23, 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.
Fixes https://deephaven.atlassian.net/browse/DH-18247
Allows autodoc functions to have no parameters and adds better error checking for params to ensure that all expected parameters are there in a fine-tuned way.
Tested on all existing docs as well as a local
use_render_queuedoc.