Skip to content

More symbolic doc aliases - #88594

Merged
bors merged 4 commits into
rust-lang:masterfrom
steffahn:more_symbolic_doc_aliases
Sep 8, 2021
Merged

More symbolic doc aliases#88594
bors merged 4 commits into
rust-lang:masterfrom
steffahn:more_symbolic_doc_aliases

Conversation

@steffahn

@steffahnsteffahn commented Sep 2, 2021

Copy link
Copy Markdown
Member

A bunch of small changes, mostly adding #[doc(alias = "…")] entries for symbolic "…".

Also a small change in documentation of const keywords.

@rust-highfive

rust-highfive commented Sep 2, 2021

Copy link
Copy Markdown
Contributor

r? @Mark-Simulacrum

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

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 2, 2021
jyn514
jyn514 reviewed Sep 2, 2021
View reviewed changes
Comment threadlibrary/std/src/primitive_docs.rs Outdated
the8472
the8472 reviewed Sep 2, 2021
View reviewed changes
Comment threadlibrary/core/src/ops/bit.rs Outdated
joshtriplett
joshtriplett reviewed Sep 4, 2021
View reviewed changes
Comment threadlibrary/core/src/ops/range.rs Outdated
joshtriplett
joshtriplett reviewed Sep 4, 2021
View reviewed changes
Comment threadlibrary/core/src/ops/function.rs Outdated
Mark-Simulacrum
Mark-Simulacrum reviewed Sep 4, 2021
View reviewed changes
Comment threadlibrary/core/src/ops/index.rs Outdated
@Mark-Simulacrum

Mark-Simulacrum commented Sep 4, 2021

Copy link
Copy Markdown
Member

Going to reassign to @joshtriplett for T-libs(-api?) discussion -- seems like some interpretation of the doc alias policy for symbols is needed.

@steffahn

steffahn commented Sep 5, 2021•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

(in review above)

IMO, this whole PR should be closed

I’d want to at least keep 49c680a, ab89c88, 56634a1, and part of 0a56598 though.

For 0a56598 I’d want to keep *, *const, and *mut for now with the intention of * being removed at a later time. Though the inclusion of * can be debated.

I’ll do that in a rebase -i + force-push, I guess… Review hasn’t really addressed any of these changes yet anyway. After rebase I’ll resolve the reviews on the removed changes.

@steffahn
steffahnforce-pushed the more_symbolic_doc_aliases branch from 4512613 to 5135d86CompareSeptember 5, 2021 17:18
@jyn514

jyn514 commented Sep 5, 2021

Copy link
Copy Markdown
Member

so it doesn't get lost in the resolved thread - the link to rustdoc's fuzzy search is

rust/src/librustdoc/html/static/js/search.js

Line 79 in c5799b2

functionlevenshtein(s1,s2){

@joshtriplett

joshtriplett commented Sep 6, 2021

Copy link
Copy Markdown
Member

The remaining items look reasonable to me.

@bors r+ rollup

@bors

bors commented Sep 6, 2021

Copy link
Copy Markdown
Collaborator

📌 Commit 5135d86 has been approved by joshtriplett

@borsbors 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 6, 2021
@jackh726jackh726 mentioned this pull request Sep 8, 2021
Merged
@the8472the8472 added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Sep 8, 2021
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 8, 2021
@bors
Auto merge ofrust-lang#88750- jackh726:rollup-w57i9fp, r=jackh726
47ae8de
Rollup of 9 pull requests
Successful merges:
- rust-lang#86263 (Rustdoc: Report Layout of enum variants)
- rust-lang#88541 (Add regression test for rust-lang#74400)
- rust-lang#88553 (Improve diagnostics for unary plus operators (rust-lang#88276))
- rust-lang#88594 (More symbolic doc aliases)
- rust-lang#88648 (Correct “copies” to “moves” in `<Option<T> as From<T>>::from` doc, and other copyediting)
- rust-lang#88691 (Add a regression test for rust-lang#88649)
- rust-lang#88694 (Drop 1.56 stabilizations from 1.55 release notes)
- rust-lang#88712 (Fix docs for `uX::checked_next_multiple_of`)
- rust-lang#88726 (Fix typo in `const_generics` replaced with `adt_const_params` note)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit b1c782f into rust-lang:masterSep 8, 2021
@rustbotrustbot added this to the 1.57.0 milestone Sep 8, 2021
@steffahn
steffahn deleted the more_symbolic_doc_aliases branch September 8, 2021 21:30
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@joshtriplettjoshtriplettjoshtriplett left review comments
@the8472the8472the8472 left review comments
@Mark-SimulacrumMark-SimulacrumMark-Simulacrum left review comments
+1 more reviewer
@jyn514jyn514jyn514 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@joshtriplettjoshtriplett

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-libsRelevant to the library team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.57.0

Development

Successfully merging this pull request may close these issues.

8 participants

@steffahn@rust-highfive@Mark-Simulacrum@jyn514@joshtriplett@bors@the8472@rustbot