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.

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

str.lines() docstring: clarify that line endings are not returned #105824

Merged
merged 1 commit into from
Dec 22, 2022

Conversation

zacchiro
Copy link
Contributor

Previously, the str.lines() docstring stated that lines are split at line endings, but not whether those were returned or not. This new version of the docstring states this explicitly, avoiding the need of getting to doctests to get an answer to this FAQ.

Previously, the str.lines() docstring stated that lines are split at line
endings, but not whether those were returned or not.  This new version of the
docstring states this explicitly, avoiding the need of getting to doctests to
get an answer to this FAQ.
@rustbot
Copy link
Collaborator

rustbot commented Dec 17, 2022

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @joshtriplett (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 Dec 17, 2022
@rustbot
Copy link
Collaborator

rustbot commented Dec 17, 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

@JohnTitor
Copy link
Member

Thank you!
r? @JohnTitor @bors r+ rollup

@bors
Copy link
Contributor

bors commented Dec 21, 2022

📌 Commit 7f94389 has been approved by JohnTitor

It is now in the queue for this repository.

@rustbot rustbot assigned JohnTitor and unassigned joshtriplett Dec 21, 2022
@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 Dec 21, 2022
fee1-dead added a commit to fee1-dead-contrib/rust that referenced this pull request Dec 21, 2022
str.lines() docstring: clarify that line endings are not returned

Previously, the str.lines() docstring stated that lines are split at line endings, but not whether those were returned or not.  This new version of the docstring states this explicitly, avoiding the need of getting to doctests to get an answer to this FAQ.
fee1-dead added a commit to fee1-dead-contrib/rust that referenced this pull request Dec 21, 2022
str.lines() docstring: clarify that line endings are not returned

Previously, the str.lines() docstring stated that lines are split at line endings, but not whether those were returned or not.  This new version of the docstring states this explicitly, avoiding the need of getting to doctests to get an answer to this FAQ.
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 22, 2022
Rollup of 8 pull requests

Successful merges:

 - rust-lang#105584 (add assert messages if chunks/windows are length 0)
 - rust-lang#105602 (interpret: add read_machine_[ui]size convenience methods)
 - rust-lang#105824 (str.lines() docstring: clarify that line endings are not returned)
 - rust-lang#105980 (Refer to "Waker" rather than "RawWaker" in `drop` comment)
 - rust-lang#105986 (Fix typo in reading_half_a_pointer.rs)
 - rust-lang#105995 (Add regression test for rust-lang#96530)
 - rust-lang#106008 (Sort lint_groups in no_lint_suggestion)
 - rust-lang#106014 (Add comment explaining what the scrape-examples-toggle.goml GUI test is about)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 257edf2 into rust-lang:master Dec 22, 2022
@rustbot rustbot added this to the 1.68.0 milestone Dec 22, 2022
Aaron1011 pushed a commit to Aaron1011/rust that referenced this pull request Jan 6, 2023
str.lines() docstring: clarify that line endings are not returned

Previously, the str.lines() docstring stated that lines are split at line endings, but not whether those were returned or not.  This new version of the docstring states this explicitly, avoiding the need of getting to doctests to get an answer to this FAQ.
Aaron1011 pushed a commit to Aaron1011/rust that referenced this pull request Jan 6, 2023
Rollup of 8 pull requests

Successful merges:

 - rust-lang#105584 (add assert messages if chunks/windows are length 0)
 - rust-lang#105602 (interpret: add read_machine_[ui]size convenience methods)
 - rust-lang#105824 (str.lines() docstring: clarify that line endings are not returned)
 - rust-lang#105980 (Refer to "Waker" rather than "RawWaker" in `drop` comment)
 - rust-lang#105986 (Fix typo in reading_half_a_pointer.rs)
 - rust-lang#105995 (Add regression test for rust-lang#96530)
 - rust-lang#106008 (Sort lint_groups in no_lint_suggestion)
 - rust-lang#106014 (Add comment explaining what the scrape-examples-toggle.goml GUI test is about)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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
Development

Successfully merging this pull request may close these issues.

5 participants