Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Add doc aliases on Sized trait #102102

Merged
merged 1 commit into from
Sep 22, 2022
Merged

Add doc aliases on Sized trait #102102

merged 1 commit into from
Sep 22, 2022

Conversation

GuillaumeGomez
Copy link
Member

Fixes #101267.

It adds both ? and ?Sized doc aliases for the Sized trait.

Some screenshots of the result:

Screenshot from 2022-09-21 16-19-55
Screenshot from 2022-09-21 16-20-04

@rustbot rustbot added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Sep 21, 2022
@rustbot
Copy link
Collaborator

rustbot commented Sep 21, 2022

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

@rust-highfive
Copy link
Collaborator

r? @thomcc

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 21, 2022
@GuillaumeGomez GuillaumeGomez mentioned this pull request Sep 21, 2022
Closed
@GuillaumeGomez GuillaumeGomez added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Sep 21, 2022
@thomcc
Copy link
Member

thomcc commented Sep 21, 2022

TIL you can put multiple aliases in one #[doc(alias)] block.

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Sep 21, 2022

📌 Commit efbde85 has been approved by thomcc

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 Sep 21, 2022
@JohnTitor JohnTitor mentioned this pull request Sep 22, 2022
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 22, 2022
@bors
Auto merge of rust-lang#102121 - JohnTitor:rollup-3fb1wrt, r=JohnTitor
626b02a 
Rollup of 12 pull requests

Successful merges:

 - rust-lang#101952 (Avoid panicking on missing fallback)
 - rust-lang#102030 (Don't crate-locally reexport walk functions in tidy)
 - rust-lang#102032 (Adding ignore fuchsia tests for signal interpretation cases)
 - rust-lang#102033 (Adding needs-unwind to nicer-assert-messages compiler ui tests)
 - rust-lang#102054 (Unify "all items" page's sidebar with other pages)
 - rust-lang#102071 (Adding needs-unwind for tests testing memory size of Futures/Closures)
 - rust-lang#102073 (Adding ignore fuchsia tests for execvp)
 - rust-lang#102075 (rustdoc: remove no-op CSS `.content > .methods > .method`)
 - rust-lang#102079 (Update books)
 - rust-lang#102084 (Adding needs-unwind for test using panic::catch_unwind)
 - rust-lang#102100 (Prevent usage of .stab elements to create scrollable areas in doc blocks)
 - rust-lang#102102 (Add doc aliases on Sized trait)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 15b4788 into rust-lang:master Sep 22, 2022
@rustbot rustbot added this to the 1.66.0 milestone Sep 22, 2022
@GuillaumeGomez GuillaumeGomez deleted the doc-aliases-sized-trait branch September 22, 2022 10:14
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers
No reviews
Assignees

@thomcc thomcc

Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.66.0
Development

Successfully merging this pull request may close these issues.

Sized trait should have #[doc(alias = "?")]
5 participants
@GuillaumeGomez @rustbot @rust-highfive @thomcc @bors