astral-sh/uv

`uv tool` should support man pages

Open

#4,731 opened on Jul 2, 2024

View on GitHub
 (6 comments) (20 reactions) (0 assignees)Rust (84,934 stars) (3,111 forks)batch import
enhancementhelp wanted

Description

pipx supports installation of man pages for documentation. We should do the same in the uv tool commands.

Contributor guide

Tech stack
rustpython
Domain
documentationtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust programming basicsUnderstanding of uv tool installation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
This issue requests adding man page support to the `uv tool` commands, similar to pipx. Start by examining how pipx handles man page installation for reference. Then explore the uv source code, particularly the `crates/uv tool` or similar modules that manage tool installation. Look for existing logic that handles tool executables and consider how to extend it to capture and install man pages. The issue has no linked PRs or assignees, so it is open for contribution. Review the comments for any additional requirements or ideas from maintainers.