Skip to content

reword Option::as_ref and Option::map examples #104965

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
Merged
merged 2 commits into from
Jan 14, 2023
Merged

reword Option::as_ref and Option::map examples #104965

merged 2 commits into from
Jan 14, 2023

Conversation

zacklukem
Copy link
Contributor

The description for the examples of Option::as_ref and Option::map imply that the example is only doing type conversion, when it is actually finding the length of a string.

Changes the wording to imply that some operation is being run on the value contained in the Option

closes #104476

@rustbot
Copy link
Collaborator

rustbot commented Nov 26, 2022

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @scottmcm (or someone else) soon.

Please see the contribution instructions for more information.

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Nov 26, 2022
@rustbot
Copy link
Collaborator

rustbot commented Nov 26, 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

@zacklukem
Copy link
Contributor Author

@rustbot label +A-docs +T-libs-api -T-libs

@rustbot rustbot 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-libs Relevant to the library team, which will review and decide on the PR/issue. labels Nov 26, 2022
@scottmcm
Copy link
Member

Looks like CI is failing?

@rustbot author

@rustbot rustbot 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-review Status: Awaiting review from the assignee but also interested parties. labels Nov 27, 2022
@zacklukem
Copy link
Contributor Author

@rustbot ready

@rustbot rustbot 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 Nov 27, 2022
@scottmcm
Copy link
Member

Thanks!

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Jan 14, 2023

📌 Commit 123e203 has been approved by scottmcm

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 Jan 14, 2023
@JohnTitor JohnTitor mentioned this pull request Jan 14, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jan 14, 2023
@bors
Auto merge of rust-lang#106833 - JohnTitor:rollup-z8398jk, r=JohnTitor
c0b8735 
Rollup of 13 pull requests

Successful merges:

 - rust-lang#104965 (reword Option::as_ref and Option::map examples)
 - rust-lang#105172 (Added error documentation for write_fmt)
 - rust-lang#106605 (rustdoc: fix outdated lint section of the book)
 - rust-lang#106670 (Check compiler docs in PR CI)
 - rust-lang#106692 (mv binary_heap.rs binary_heap/mod.rs)
 - rust-lang#106693 (rustdoc: rename CSS rustdoc-toggle -> toggle and toggle -> settings-toggle)
 - rust-lang#106707 (Remove duplicate sha-1 dependency)
 - rust-lang#106762 (Add `AtomicPtr::as_mut_ptr`)
 - rust-lang#106766 (Remove dead code in rustdoc stripper)
 - rust-lang#106775 (Remove stale reference to the test suite location)
 - rust-lang#106799 (Stop having unused lifetimes on some `impl`s)
 - rust-lang#106816 (Update `rental` hack to work with remapped paths.)
 - rust-lang#106819 (rustdoc: remove unnecessary DOM class `h1.fqn`)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 6702f20 into rust-lang:master Jan 14, 2023
@rustbot rustbot added this to the 1.68.0 milestone Jan 14, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers
No reviews
Assignees

@scottmcm scottmcm

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.68.0
Development

Successfully merging this pull request may close these issues.

Option.as_ref() possible example mistake?
4 participants
@zacklukem @rustbot @scottmcm @bors