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

Adjust the docs for the pip CLI commands #4445

Merged
merged 1 commit into from
Jun 23, 2024
+6 −6
Merged

Adjust the docs for the pip CLI commands #4445

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions crates/uv/src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,19 +215,19 @@ pub(crate) struct PipNamespace {
pub(crate) enum PipCommand {
/// Compile a `requirements.in` file to a `requirements.txt` file.
Compile(PipCompileArgs),
/// Sync dependencies from a `requirements.txt` file.
/// Sync an environment with a `requirements.txt` file.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"dependencies" is unclear and doesn't cover removal of packages

Sync(PipSyncArgs),
/// Install packages into the current environment.
/// Install packages into an environment.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not always the current environment, I find this confusing.

Install(PipInstallArgs),
/// Uninstall packages from the current environment.
/// Uninstall packages from an environment.
Uninstall(PipUninstallArgs),
/// Enumerate the installed packages in the current environment.
/// Enumerate the installed packages in an environment.
Freeze(PipFreezeArgs),
/// Enumerate the installed packages in the current environment.
/// Enumerate the installed packages in an environment.
List(PipListArgs),
/// Show information about one or more installed packages.
Show(PipShowArgs),
/// Display the dependency tree.
/// Display the dependency tree for an environment.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency

Tree(PipTreeArgs),
/// Verify installed packages have compatible dependencies.
Check(PipCheckArgs),
Expand Down
Loading