-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: Allow autodoc functions to have no parameters #1072
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Works for use_render_queue
, but had a question about the error case when a function is missing parameters.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
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_queue
doc.