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.

Sign up for GitHub

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

Jump to bottom

Update the intra-doc link RFC to match the implementation #2975

Merged
merged 4 commits into from
Aug 30, 2020
Merged

Update the intra-doc link RFC to match the implementation #2975

merged 4 commits into from
Aug 30, 2020

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Aug 20, 2020 •
edited
Loading

  • Mention the behavior for cross-crate re-exports
  • Mention the behavior for linking to private items
  • Require that disambiguators match, even if they're in the same namespace
  • For the extension on associated items, require that traits be in scope to link to their associated items
  • Add a possible Deref extension Removed, this is not implemented, and it's not clear if it will be implemented.

The only behavior change from the original RFC is that disambiguators must now match (see also rust-lang/rust#74851 and rust-lang/rust#75079). All other changes are either clarifications or possible extensions.

r? @Manishearth

@jyn514
Update the intra-doc link RFC to match the implementation
acf6514 
- Mention the behavior for cross-crate re-exports
- Mention the behavior for linking to private items
- Require that disambiguators match, even if they're in the same
  namespace
- For the extension on associated items, require that traits be in scope
  to link to their associated items
- Add a possible `Deref` extension
@jyn514
Copy link
Member Author

jyn514 commented Aug 20, 2020

See also rust-lang/rust#43466 (comment).

@jyn514
Remove Deref extension
a09c059 
This is not implemented and it's not clear it will be implemented.
Since this PR is only intended to match the current implementation,
I removed it from the RFC.
Manishearth
Manishearth approved these changes Aug 20, 2020
View reviewed changes
Copy link
Member

@Manishearth Manishearth left a comment

Choose a reason for hiding this comment

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

This RFC really should have been an eRFC, but we've treated it as such anyway. We should do a quick FCP on this and merge it

@Manishearth Manishearth added the T-rustdoc Relevant to rustdoc team, which will review and decide on the RFC. label Aug 20, 2020
@Manishearth
Copy link
Member

We did the same in #2285 (comment)

@rfcbot fcp merge

@rfcbot
Copy link
Collaborator

rfcbot commented Aug 20, 2020 •
edited by GuillaumeGomez
Loading

Team member @Manishearth has proposed to merge this. The next step is review by the rest of the tagged team members:

No concerns currently listed.

Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

@rfcbot rfcbot added proposed-final-comment-period Currently awaiting signoff of all team members in order to enter the final comment period. disposition-merge This RFC is in PFCP or FCP with a disposition to merge it. labels Aug 20, 2020
@jyn514
Copy link
Member Author

jyn514 commented Aug 20, 2020

@rfcbot reviewed

@rfcbot rfcbot added the final-comment-period Will be merged/postponed/closed in ~10 calendar days unless new substational objections are raised. label Aug 20, 2020
@rfcbot
Copy link
Collaborator

rfcbot commented Aug 20, 2020

🔔 This is now entering its final comment period, as per the review above. 🔔

@rfcbot rfcbot removed the proposed-final-comment-period Currently awaiting signoff of all team members in order to enter the final comment period. label Aug 20, 2020
killercup
killercup approved these changes Aug 20, 2020
View reviewed changes
Copy link
Member

@killercup killercup left a comment

Choose a reason for hiding this comment

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

Good updates, very much in spirit of the original RFC 👍

ollie27
ollie27 reviewed Aug 20, 2020
View reviewed changes
text/1946-intra-rustdoc-links.md Outdated Show resolved Hide resolved
text/1946-intra-rustdoc-links.md Outdated Show resolved Hide resolved
@rfcbot rfcbot added finished-final-comment-period The final comment period is finished for this RFC. to-announce and removed final-comment-period Will be merged/postponed/closed in ~10 calendar days unless new substational objections are raised. labels Aug 30, 2020
@rfcbot
Copy link
Collaborator

rfcbot commented Aug 30, 2020

The final comment period, with a disposition to merge, as per the review above, is now complete.

As the automated representative of the governance process, I would like to thank the author for their work and everyone else who contributed.

The RFC will be merged soon.

@Manishearth Manishearth merged commit 12ec6ac into rust-lang:master Aug 30, 2020
@jyn514 jyn514 deleted the intra-doc-links branch August 30, 2020 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Manishearth Manishearth Manishearth approved these changes

@ollie27 ollie27 ollie27 left review comments

@killercup killercup killercup approved these changes

Assignees
No one assigned
Labels
disposition-merge This RFC is in PFCP or FCP with a disposition to merge it. finished-final-comment-period The final comment period is finished for this RFC. T-rustdoc Relevant to rustdoc team, which will review and decide on the RFC. to-announce
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jyn514 @Manishearth @rfcbot @killercup @ollie27