Skip to content
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

Merged
merged 8 commits into from
Dec 23, 2024

Conversation

jnumainville
Copy link
Collaborator

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.

@jnumainville jnumainville requested a review from mofojed December 19, 2024 17:53
Copy link
Member

@mofojed mofojed left a 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.

@@ -46,31 +46,37 @@ class SignatureData(TypedDict):

AUTOFUNCTION_COMMENT_PREFIX = "AutofunctionCommentPrefix:"

UNDOCUMENTED_PARAMS = {"*"}
Copy link
Member

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@mofojed mofojed merged commit 6b261d6 into deephaven:main Dec 23, 2024
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants