-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
Document registries. #6594
Document registries. #6594
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very thorough!!! I only have tiny places where clarity/precision could be increased and a few small typos that I saw :)
src/doc/src/reference/registries.md
Outdated
registry is [crates.io]. A registry contains an "index" which contains a | ||
searchable list of available crates. A registry may also provide a web API to | ||
support publishing new crates directly from Cargo. The registry provides | ||
permanent access to all versions of a package that have been published to it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The registry provides permanent access to all versions of a package that have been published to it.
This is a guarantee crates.io has chosen to make; other registries might choose not to make this guarantee. If "The registry" was changed to "crates.io", I think this'd be fine :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just removed it, I feel like it wasn't saying anything useful or correct.
Thank you very much for the detailed review! It's frustrating when I read something many times and still miss the obvious mistakes. |
Moved to #6654. |
(Do not merge.)
Rendered
This is a preview of the documentation for registries, posted for early review. I intend to include it when actually stabilizing alternative registries. There are many minor places in the documentation that will get updated at that time, but that mostly involves removing unstable notices or adding small notes that are included here.
I would appreciate if someone on @rust-lang/crates-io would take a look over this at some point. This intentionally only documents a minimum of the web API that Cargo uses. The format is a bit ad-hoc, but I think it is clear enough to get the points across.