Skip to content

Add lists of values to module documentation#69

Merged
mivade merged 1 commit intomivade:mainfrom
jon-edward:main
Jun 2, 2025
Merged

Add lists of values to module documentation#69
mivade merged 1 commit intomivade:mainfrom
jon-edward:main

Conversation

@jon-edward
Copy link
Copy Markdown
Contributor

This adds reference to nargs='+' as a method of handling lists of arguments to the module docstring

@jon-edward
Copy link
Copy Markdown
Contributor Author

This is a workaround for #63.

@mivade
Copy link
Copy Markdown
Owner

mivade commented Jun 2, 2025

I think this is probably the right way to handle #69 since just specifying list[str] (or whatever) can be ambiguous from the perspective of the nargs kwarg.

Closes #69.

@mivade mivade merged commit 89e37e1 into mivade:main Jun 2, 2025
5 checks passed
@mivade
Copy link
Copy Markdown
Owner

mivade commented Jun 2, 2025

Thanks @jon-edward!

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