-
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
crates-io: Add doc comment for NewCrate
struct
#12782
Conversation
r? @epage (rustbot has picked a reviewer for you, use r? to override) |
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.
Just need to bump the version of the crate so it gets a release with this change.
probably no need to bump it just for this change. it was mostly helpful for me while browsing the cargo codebase :) |
oh wait, now that I see the failing CI... did you mean to say that I should bump the version myself? how are changelogs etc. handled in that case? |
Yes, to fix CI the version needs to be bumped. Its a crude check, making us release more often than we would otherwise, but we've had too many times where we forgot to release. So far we don't have per-crate changelogs. I'm researching options for that. |
14b321e
to
9e5dac1
Compare
@bors r+ |
Thanks! |
☀️ Test successful - checks-actions |
1 similar comment
☀️ Test successful - checks-actions |
👀 Test was successful, but fast-forwarding failed: 422 Changes must be made through a pull request. |
This PR adds a small doc comment to the
NewCrate
struct in thecrates-io
package, linking to https://doc.rust-lang.org/cargo/reference/registry-web-api.html#publish to give additional context.I saw other links to https://doc.rust-lang.org in some of the doc comments, so I'm hoping this is correct vs. linking directly to the file with a relative path?