Skip to content

Add metavars for improved docstring rendering #252

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.

Sign up for GitHub

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

Jump to bottom
Merged
stefanv merged 1 commit into from
Nov 19, 2024
Merged

Add metavars for improved docstring rendering #252

stefanv merged 1 commit into from
Nov 19, 2024
+22 −4

Conversation

@stefanv
Copy link
Member

@stefanv stefanv commented Nov 18, 2024 •
edited
Loading

From the click docs:

metavar (str | None) – how the value is represented in the help page.

@stefanv stefanv added the type: Documentation Improvements or additions to documentation label Nov 18, 2024
@stefanv stefanv merged commit b1c893d into scientific-python:main Nov 19, 2024
20 of 21 checks passed
@jarrodmillman jarrodmillman added this to the 0.13 milestone Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

type: Documentation Improvements or additions to documentation

Projects

None yet

Milestone

0.13

Development

Successfully merging this pull request may close these issues.

2 participants

@stefanv @jarrodmillman