Skip to content

Add a note about the design change of RFC 2906 in implementation #3321

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

Merged
merged 2 commits into from
Sep 28, 2022
Merged

Add a note about the design change of RFC 2906 in implementation #3321

merged 2 commits into from
Sep 28, 2022

Conversation

messense
Copy link
Contributor

@messense messense commented Sep 27, 2022

rust-lang/cargo#10564 changed the metadata inheritance source from workspace to workspace.package

Rendered

rust-lang/cargo#10564 changed the metadata inheritance source from `workspace` to `workspace.package`
@ehuss
Copy link
Contributor

ehuss commented Sep 27, 2022

Thanks for the PR! I'm reluctant to merge this because we generally do not update RFCs to incorporate changes that happen afterwards. They exist as a snapshot in time of the decision that was made when the RFC was merged. There were several other changes to the RFC that this doesn't cover, and I don't want to start an impression that the RFC is being kept up-to-date, or that it is the resource people should be using for learning about a feature. If the documentation doesn't contain enough information, then I think that we should try to address that.

I do recognize that discovery of the documentation may not be great. In the future, I'll try to update tracking issues with more details after stabilization.

For this RFC, I think it would be reasonable to just put a note towards the top directing users to the stabilized documentation. Perhaps something like:

Note: This feature was stabilized in Rust 1.64. Several design changes were made in the course of the implementation. Please see the documentation for [workspace.package] and [workspace.dependencies] for details on how to use this feature.

We're discussing perhaps making a more formal way of linking something like the stabilized documentation (such as a new header at the top), but that may take a while to finalize.

@ehuss ehuss added T-cargo Relevant to the Cargo team, which will review and decide on the RFC. not-rfc For PRs that fix things like spelling mistakes, wrong file names, etc. labels Sep 27, 2022
@messense
Copy link
Contributor Author

@ehuss Changed to a note, thanks for the review!

@messense messense changed the title Update RFC 2906 to match the implementation Add a note about the design change of RFC 2906 Sep 28, 2022
@messense messense changed the title Add a note about the design change of RFC 2906 Add a note about the design change of RFC 2906 in implementation Sep 28, 2022
Copy link
Contributor

@ehuss ehuss left a comment

Choose a reason for hiding this comment

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

Thanks!

@ehuss ehuss merged commit 8b63d58 into rust-lang:master Sep 28, 2022
@messense messense deleted the patch-1 branch September 28, 2022 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
not-rfc For PRs that fix things like spelling mistakes, wrong file names, etc. T-cargo Relevant to the Cargo team, which will review and decide on the RFC.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants