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.

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

Docs: annotate params with description not help #18840

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Docs: annotate params with description not help #18840

wants to merge 1 commit into from
+2 −2

Conversation

premultiply
Copy link
Member

This will change the rendering of the autogenerated docs. It will print the "description" instead of the "help" values from template to the docs as comment after each param.

@premultiply premultiply requested a review from naltatis February 15, 2025 18:32
@premultiply premultiply added infrastructure Basic functionality needs decision Unsure if we should really do this labels Feb 15, 2025
@naltatis
Copy link
Member

We can decide do add both. But we can't simply drop help. Right now there is a lot of nerecessry info required for filing out the value.

@github-actions github-actions bot added the stale Outdated and ready to close label Feb 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@naltatis naltatis Awaiting requested review from naltatis

Assignees
No one assigned
Labels
infrastructure Basic functionality needs decision Unsure if we should really do this stale Outdated and ready to close
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@premultiply @naltatis