Skip to content

fix grammar, and remove confusing example #15457

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
merged 2 commits into from
Apr 30, 2025
Merged

fix grammar, and remove confusing example #15457

merged 2 commits into from
Apr 30, 2025

Conversation

tshepang
Copy link
Member

@tshepang tshepang commented Apr 26, 2025 •
edited
Loading

Also, lots of commands need to contact the registry, so seeing an example gives me doubt.

@rustbot
Copy link
Collaborator

rustbot commented Apr 26, 2025

r? @epage

rustbot has assigned @epage.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 26, 2025
@rustbot

This comment has been minimized.

Sign in to view
@tshepang tshepang marked this pull request as draft April 27, 2025 14:22
@tshepang
fix grammar, and remove confusing example
12b68be 
Lots of commands need to contact the registry,
and seeing an example made me doubt that.
@tshepang tshepang marked this pull request as ready for review April 27, 2025 14:47
@epage
Copy link
Contributor

epage commented Apr 28, 2025

remove confusing example

Also, lots of commands need to contact the registry, seeing an example gives me doubt

For commands that contact the registry, we have

  • cargo login
  • cargo logout
  • cargo install
  • cargo yank
  • cargo publish
  • cargo package
  • cargo search

Could you help me understand how giving the example of cargo publish gave you doubt / is confusing?

@tshepang
Copy link
Member Author

Because there is a lot of them, listing just one made me doubt that fact. It made me think it's publish and just 1 or 2 more.

@epage
Copy link
Contributor

epage commented Apr 28, 2025

Maybe my perspective is biased but that is a small subset of our overall commands and having a concrete example of "this is what touching the registry looks like that might need this flag" I feel like helps take something abstract and make it concrete.

For example, when I saw this PR description of "lots of commands", I thought you were also referring to commands like cargo check and I had to go double check because I didn't think that was the case.

@weihanglo
Copy link
Member

What about referring to https://doc.rust-lang.org/nightly/cargo/commands/publishing-commands.html?

@tshepang
Copy link
Member Author

For example, when I saw this PR description of "lots of commands", I thought you were also referring to commands like cargo check and I had to go double check because I didn't think that was the case.

is it not cargo check also touches registry when lockfile is stale enough, as well as others like cargo build, or even cargo test

@epage
Copy link
Contributor

epage commented Apr 28, 2025

is it not cargo check also touches registry when lockfile is stale enough, as well as others like cargo build, or even cargo test

They do but they use the dependency registry field rather than a --registry command line parameter.

Check cargo check -h. It does not list a --registry option.

Some commands beyond what I listed have a --regsitry option but its for purposes other than listed here (e.g. cargo add --registry is for setting the dependency registry field, not for directly communicating with registries).

@tshepang
Copy link
Member Author

tshepang commented Apr 30, 2025 •
edited
Loading

used #15457 (comment) to help clarify things

epage
epage approved these changes Apr 30, 2025
View reviewed changes
Copy link
Contributor

@epage epage left a comment

Choose a reason for hiding this comment

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

Unsure how I feel about a footnote but we can see how this goes

@epage epage added this pull request to the merge queue Apr 30, 2025
Merged via the queue into rust-lang:master with commit 1649ee2 Apr 30, 2025
23 checks passed
@tshepang tshepang deleted the patch-1 branch April 30, 2025 15:24
@weihanglo weihanglo mentioned this pull request May 9, 2025
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request May 10, 2025
@bors
Auto merge of rust-lang#140876 - weihanglo:update-cargo, r=weihanglo
c6faa1b 
Update cargo

25 commits in 7918c7eb59614c39f1c4e27e99d557720976bdd7..056f5f4f3c100cb36b5e9aed2d20b9ea70aae295
2025-04-27 09:44:23 +0000 to 2025-05-09 14:54:18 +0000
- Revert "doc: Mention `XDG_DATA_HOME`" (rust-lang/cargo#15512)
- docs: update version notice for deprecation removal (rust-lang/cargo#15511)
- doc: Update instructions on using native-completions (rust-lang/cargo#15480)
- feat(network): use Retry-After header for HTTP 429 responses (rust-lang/cargo#15463)
- CI: Require schema job to pass (rust-lang/cargo#15504)
- chore(config): migrate renovate config (rust-lang/cargo#15501)
- Make cargo script ignore workspaces (rust-lang/cargo#15496)
- fix(rustc): Don't panic on unknown bins (rust-lang/cargo#15497)
- test: Remove unused nightly requirements (rust-lang/cargo#15498)
- Add support for `-Zembed-metadata` (rust-lang/cargo#15378)
- Fix tracking issue template link (rust-lang/cargo#15494)
- Refactor artifact deps in FeatureResolver::deps (rust-lang/cargo#15492)
- Improved error message for versions prefixed with `v` (rust-lang/cargo#15484)
- chore: fix some typos in comment (rust-lang/cargo#15485)
- fix: default to all targets when using `--edition` and ` --edition-idioms` in cargo fix (rust-lang/cargo#15192)
- Update fingerprint footnote (rust-lang/cargo#15478)
- feat(add): suggest similarly named features (rust-lang/cargo#15438)
- In package-workspace, keep dev-dependencies if they have a version (rust-lang/cargo#15470)
- docs: fix a typo in DependencyUI (rust-lang/cargo#15472)
- fix grammar, and remove confusing example (rust-lang/cargo#15457)
- Added tracing spans for rustc invocations (rust-lang/cargo#15464)
- Trivial tweaks to 'target_short_hash' (rust-lang/cargo#15461)
- chore(deps): update msrv (3 versions) to v1.84 (rust-lang/cargo#15456)
- feat(add/install): check if given crate argument would be valid with inserted @ symbol (rust-lang/cargo#15441)
- chang 1 tries to 1 try (rust-lang/cargo#15328)

r? ghost
@rustbot rustbot added this to the 1.89.0 milestone May 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@epage epage epage approved these changes

Assignees

@epage epage

Labels
A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Milestone
1.89.0
Development

Successfully merging this pull request may close these issues.
4 participants
@tshepang @rustbot @epage @weihanglo