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

Makes docs for references a little less confusing #88361

Merged
merged 4 commits into from
Nov 20, 2021
Merged

Makes docs for references a little less confusing #88361

merged 4 commits into from
Nov 20, 2021

Conversation

WaffleLapkin
Copy link
Member

  • Make clear that the Pointer trait is related to formatting
  • Make clear that the Pointer trait is implemented for references (previously it was confusing to first see that it's implemented and then see it in "expect")
  • Make clear that &T (shared reference) implements Send (if T: Send + Sync)

@rust-highfive
Copy link
Contributor

r? @joshtriplett

(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 Aug 26, 2021
@bors
Copy link
Collaborator

bors commented Sep 5, 2021

☔ The latest upstream changes (presumably #88469) made this pull request unmergeable. Please resolve the merge conflicts.

@apiraino apiraino added the T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. label Sep 13, 2021
@JohnCSimon JohnCSimon added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 3, 2021
@joshtriplett
Copy link
Member

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Oct 4, 2021

📌 Commit aba3608 has been approved by joshtriplett

@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 Oct 4, 2021
Manishearth added a commit to Manishearth/rust that referenced this pull request Oct 4, 2021
@Manishearth
Rollup merge of rust-lang#88361 - WaffleLapkin:patch-2, r=joshtriplett
bfdaab8 
Makes docs for references a little less confusing

- Make clear that the `Pointer` trait is related to formatting
- Make clear that the `Pointer` trait is implemented for references (previously it was confusing to first see that it's implemented and then see it in "expect")
- Make clear that `&T` (shared reference) implements `Send` (if `T: Send + Sync`)
@Manishearth Manishearth mentioned this pull request Oct 4, 2021
Closed
@Manishearth
Copy link
Member 

tidy error: library/core/src/primitive_docs.rs and library/std/src/primitive_docs.rs have different contents

@bors r-

@bors bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Oct 4, 2021
WaffleLapkin and others added 3 commits October 10, 2021 14:03
@WaffleLapkin
Makes docs for references a little less confusing
7a47786 
- Make clear that the `Pointer` trait is related to formatting
- Make clear that `&T` (shared reference) implements `Send` (if `T: Send + Sync`)
@WaffleLapkin @fmease
Update library/std/src/primitive_docs.rs
9a4530b 
Co-authored-by: fmease <liehr.exchange@gmx.net>
@WaffleLapkin
Update core primitives_docs.rs up to date with std
26aec6c
@WaffleLapkin
Copy link
Member Author

@Manishearth I've updated the core docs too, so now everything should be fine

@Manishearth
Copy link
Member

Probably best to ask @joshtriplett for a rereview, I was just managing the bors queue and typically don't closely review PRs

@jackh726 jackh726 added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 23, 2021
@JohnCSimon JohnCSimon added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 8, 2021
@WaffleLapkin
Copy link
Member Author

ping @joshtriplett

jyn514
jyn514 suggested changes Nov 19, 2021
View reviewed changes
@jyn514 jyn514 added A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. and removed T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Nov 19, 2021
@jyn514
Copy link
Member

jyn514 commented Nov 19, 2021

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Nov 19, 2021

📌 Commit cdb0c29 has been approved by jyn514

@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 Nov 19, 2021
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Nov 19, 2021
@matthiaskrgr
Rollup merge of rust-lang#88361 - WaffleLapkin:patch-2, r=jyn514
6320b99 
Makes docs for references a little less confusing

- Make clear that the `Pointer` trait is related to formatting
- Make clear that the `Pointer` trait is implemented for references (previously it was confusing to first see that it's implemented and then see it in "expect")
- Make clear that `&T` (shared reference) implements `Send` (if `T: Send + Sync`)
@matthiaskrgr matthiaskrgr mentioned this pull request Nov 19, 2021
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Nov 19, 2021
@matthiaskrgr
Rollup merge of rust-lang#88361 - WaffleLapkin:patch-2, r=jyn514
495b6a4 
Makes docs for references a little less confusing

- Make clear that the `Pointer` trait is related to formatting
- Make clear that the `Pointer` trait is implemented for references (previously it was confusing to first see that it's implemented and then see it in "expect")
- Make clear that `&T` (shared reference) implements `Send` (if `T: Send + Sync`)
@matthiaskrgr matthiaskrgr mentioned this pull request Nov 19, 2021
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Nov 19, 2021
@matthiaskrgr
Rollup merge of rust-lang#88361 - WaffleLapkin:patch-2, r=jyn514
6df0106 
Makes docs for references a little less confusing

- Make clear that the `Pointer` trait is related to formatting
- Make clear that the `Pointer` trait is implemented for references (previously it was confusing to first see that it's implemented and then see it in "expect")
- Make clear that `&T` (shared reference) implements `Send` (if `T: Send + Sync`)
@matthiaskrgr matthiaskrgr mentioned this pull request Nov 19, 2021
Closed
@matthiaskrgr matthiaskrgr mentioned this pull request Nov 20, 2021
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 20, 2021
@bors
Auto merge of rust-lang#91064 - matthiaskrgr:rollup-2ijidpt, r=matthi…
3b65165 
…askrgr

Rollup of 8 pull requests

Successful merges:

 - rust-lang#88361 (Makes docs for references a little less confusing)
 - rust-lang#90089 (Improve display of enum variants)
 - rust-lang#90956 (Add a regression test for rust-lang#87573)
 - rust-lang#90999 (fix CTFE/Miri simd_insert/extract on array-style repr(simd) types)
 - rust-lang#91026 (rustdoc doctest: detect `fn main` after an unexpected semicolon)
 - rust-lang#91035 (Put back removed empty line)
 - rust-lang#91044 (Turn all 0x1b_u8 into '\x1b' or b'\x1b')
 - rust-lang#91054 (rustdoc: Fix some unescaped HTML tags in docs)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 97bd45b into rust-lang:master Nov 20, 2021
@rustbot rustbot added this to the 1.58.0 milestone Nov 20, 2021
@WaffleLapkin WaffleLapkin deleted the patch-2 branch February 6, 2025 21:43
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@fmease fmease fmease left review comments

@jyn514 jyn514 jyn514 requested changes

Assignees

@jyn514 jyn514

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-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.58.0
Development

Successfully merging this pull request may close these issues.