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

Show Python tool versions in top-level help text and documentation #20912

Closed
krishnan-chandra opened this issue May 13, 2024 · 0 comments · Fixed by #20921
Closed

Show Python tool versions in top-level help text and documentation #20912

krishnan-chandra opened this issue May 13, 2024 · 0 comments · Fixed by #20921
Assignees
@krishnan-chandra
Labels
backend: Python Python backend-related issues category:documentation documentation

Comments

@krishnan-chandra
Copy link
Contributor

krishnan-chandra commented May 13, 2024 •
edited

Is your feature request related to a problem? Please describe.

Follow-on from #20722 and #20901 (comment).

Describe the solution you'd like

In addition to showing the tool version in the install_from_resolve option docs, we should also show the tool version in the top-level help documentation for each tool.

Describe alternatives you've considered

See #20901 (comment) - alternative would be to add in an extended help field across all Subsystem classes which is not ideal.

Additional context
Add any other context or screenshots about the feature request here.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@krishnan-chandra krishnan-chandra

Labels
backend: Python Python backend-related issues category:documentation documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add help_short field for Python tools and use it to generate the help text krishnan-chandra/pants
1 participant
@krishnan-chandra