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

docs: doc comments for registry source and index #12239

Merged
merged 3 commits into from
Jun 7, 2023

Conversation

weihanglo
Copy link
Member

What does this PR try to resolve?

More doc comments for registry sources module and registry index management.

How should we test and review this PR?

cargo doc --document-private-items --no-deps --open

Then proofread it!

Additional information

More follow-ups for other source implementations are coming.

@rustbot
Copy link
Collaborator

rustbot commented Jun 7, 2023

r? @ehuss

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added A-registries Area: registries S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 7, 2023
@weihanglo weihanglo force-pushed the source-registry-doc branch from aa15fa7 to 7888167 Compare June 7, 2023 15:36
@epage
Copy link
Contributor

epage commented Jun 7, 2023

@bors r+

@bors
Copy link
Contributor

bors commented Jun 7, 2023

📌 Commit 7888167 has been approved by epage

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 Jun 7, 2023
@bors
Copy link
Contributor

bors commented Jun 7, 2023

⌛ Testing commit 7888167 with merge a8ed33f...

@bors
Copy link
Contributor

bors commented Jun 7, 2023

☀️ Test successful - checks-actions
Approved by: epage
Pushing a8ed33f to master...

@bors bors merged commit a8ed33f into rust-lang:master Jun 7, 2023
@weihanglo weihanglo deleted the source-registry-doc branch June 7, 2023 16:55
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jun 10, 2023
Update cargo

12 commits in b0fa79679e717cd077b7fc0fa4166f47107f1ba9..49b6d9e179a91cf7645142541c9563443f64bf2b
2023-06-03 14:19:48 +0000 to 2023-06-09 17:21:19 +0000
- docs: doc comments for all registry kinds (rust-lang/cargo#12247)
- chore: Migrate print-ban from test to clippy (rust-lang/cargo#12246)
- fix: fetch nested git submodules (rust-lang/cargo#12244)
- refactor: registry source cleanup (rust-lang/cargo#12240)
- test: loose overly matches for git cli output (rust-lang/cargo#12241)
- fix: disable multiplexing on macOS for some versions of curl (rust-lang/cargo#12234)
- docs: doc comments for registry source and index (rust-lang/cargo#12239)
- doc: point to nightly cargo doc (rust-lang/cargo#12237)
- Upgrade to `gix` v0.45 for multi-round pack negotiations. (rust-lang/cargo#12236)
- refactor: git source cleanup (rust-lang/cargo#12197)
- Add message on reusing previous temporary path on failed cargo installs (rust-lang/cargo#12231)
- doc: the first line should be a simple sentence instead of a heading (rust-lang/cargo#12228)

r? `@ghost`
@ehuss ehuss added this to the 1.72.0 milestone Jun 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-registries Area: registries 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