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.

Sign up for GitHub

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

Jump to bottom

Docs: Explain why/when .lines() returns an error #38505

Merged
merged 1 commit into from
Dec 25, 2016
Merged

Docs: Explain why/when .lines() returns an error #38505

merged 1 commit into from
Dec 25, 2016

Conversation

estebank
Copy link
Contributor

Fix #37744.

@rust-highfive
Copy link
Collaborator

r? @sfackler

(rust_highfive has picked a reviewer for you, use r? to override)

@frewsxcv
Copy link
Member

I think it might be good to have these same changes on the Lines structure that is returned from this method. What do you think?

@estebank
Copy link
Contributor Author

@frewsxcv struct Lines already points to lines() where the error information was added. I can definitely add it, but then there'd be two places with docs that need to be kept in sync.

frewsxcv
frewsxcv reviewed Dec 22, 2016
View reviewed changes
src/libstd/io/mod.rs
///
/// # Errors
///
/// Each line of the iterator has the same error semantics as [`BufRead::read_line()`].
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a big deal, but in the future, you don't need to add () in the method name. Not too concerned with this right now since we'll probably remove them all in bulk sometime in the future.

@frewsxcv
Copy link
Member

@frewsxcv struct Lines already points to lines() where the error information was added. I can definitely add it, but then there'd be two places with docs that need to be kept in sync.

Fair enough, I don't feel that strongly anyways.

Thanks for the PR!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Dec 22, 2016

📌 Commit 24334a0 has been approved by frewsxcv

steveklabnik added a commit to steveklabnik/rust that referenced this pull request Dec 24, 2016
@steveklabnik
Rollup merge of rust-lang#38505 - estebank:why-lines, r=frewsxcv
3c26ff4 
Docs: Explain why/when `.lines()` returns an error

Fix rust-lang#37744.
@steveklabnik steveklabnik mentioned this pull request Dec 24, 2016
Merged
bors added a commit that referenced this pull request Dec 24, 2016
@bors
Auto merge of #38594 - steveklabnik:rollup, r=steveklabnik
e60aa62 
Rollup of 14 pull requests

- Successful merges: #37956, #38013, #38297, #38480, #38497, #38502, #38505, #38513, #38521, #38549, #38554, #38557, #38568, #38572
- Failed merges:
@bors bors merged commit 24334a0 into rust-lang:master Dec 25, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frewsxcv frewsxcv frewsxcv left review comments

Assignees

@sfackler sfackler

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@estebank @rust-highfive @frewsxcv @bors @sfackler