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.

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

refactor: give some better examples for package ID spec #13202

Merged
merged 1 commit into from
Dec 25, 2023

Conversation

Rustin170506
Copy link
Member

What does this PR try to resolve?

The old examples are so confusing because Cargo does not use those formats. For instance: We use https://github.com/rust-lang/crates.io-index#foo instead of https://github.com/rust-lang/crates.io-index/foo. You can verify it by using the cargo pkgid command.

How should we test and review this PR?

It should covered by rustdoc tests.

Additional information

r? @epage

We discussed it one time during Cargo office hours.

Signed-off-by: hi-rustin <rustin.liu@gmail.com>
@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 25, 2023
Copy link
Member

@weihanglo weihanglo left a comment

Choose a reason for hiding this comment

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

Thanks!

@weihanglo
Copy link
Member

@bors r+

@bors
Copy link
Contributor

bors commented Dec 25, 2023

📌 Commit ad18dd0 has been approved by weihanglo

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 25, 2023
@bors
Copy link
Contributor

bors commented Dec 25, 2023

⌛ Testing commit ad18dd0 with merge 4e792c2...

@bors
Copy link
Contributor

bors commented Dec 25, 2023

☀️ Test successful - checks-actions
Approved by: weihanglo
Pushing 4e792c2 to master...

@bors bors merged commit 4e792c2 into rust-lang:master Dec 25, 2023
20 checks passed
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 27, 2023
Update cargo

7 commits in 363a2d11320faf531f6aacd1ea067c6bc08343b9..ac6bbb33293d8d424c17ecdb42af3aac25fb7295
2023-12-22 03:12:42 +0000 to 2023-12-26 23:22:08 +0000
- docs: fix link to nightly doc of cargo-util-schemas (rust-lang/cargo#13209)
- doc: improve word usage (rust-lang/cargo#13206)
- fix: clarify `--path` is the installation source not destination (rust-lang/cargo#13205)
- refactor: give some better examples for package ID spec (rust-lang/cargo#13202)
- chore: fix a typo (rust-lang/cargo#13201)
- Extend the build directive syntax with `cargo::` (rust-lang/cargo#12201)
- Rework `--check-cfg` generation comment (rust-lang/cargo#13195)

r? ghost
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 27, 2023
Update cargo

7 commits in 363a2d11320faf531f6aacd1ea067c6bc08343b9..ac6bbb33293d8d424c17ecdb42af3aac25fb7295
2023-12-22 03:12:42 +0000 to 2023-12-26 23:22:08 +0000
- docs: fix link to nightly doc of cargo-util-schemas (rust-lang/cargo#13209)
- doc: improve word usage (rust-lang/cargo#13206)
- fix: clarify `--path` is the installation source not destination (rust-lang/cargo#13205)
- refactor: give some better examples for package ID spec (rust-lang/cargo#13202)
- chore: fix a typo (rust-lang/cargo#13201)
- Extend the build directive syntax with `cargo::` (rust-lang/cargo#12201)
- Rework `--check-cfg` generation comment (rust-lang/cargo#13195)

r? ghost
@rustbot rustbot added this to the 1.77.0 milestone Dec 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants