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

Document possible io::ErrorKinds of fs::open #42925

Merged
merged 2 commits into from
Jul 1, 2017
Merged

Document possible io::ErrorKinds of fs::open #42925

merged 2 commits into from
Jul 1, 2017

Conversation

tbu-
Copy link
Contributor

@tbu- tbu- commented Jun 27, 2017

Try to make clear that this isn't an API guarantee for now, as we likely
want to refine these errors in the future, e.g. ENOSPC "No space left
on device".

CC #40322

@tbu-
Document possible io::ErrorKinds of fs::open
71252d9 
Try to make clear that this isn't an API guarantee for now, as we likely
want to refine these errors in the future, e.g. `ENOSPC` "No space left
on device".

CC rust-lang#40322
@tbu-
Copy link
Contributor Author

tbu- commented Jun 27, 2017

I'd also try the other fs function if this format is OK.

@frewsxcv frewsxcv added A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 27, 2017
@arielb1 arielb1 assigned sfackler and GuillaumeGomez and unassigned sfackler Jun 27, 2017
@arielb1
Copy link
Contributor

arielb1 commented Jun 27, 2017

r? @GuillaumeGomez

frewsxcv
frewsxcv reviewed Jun 28, 2017
View reviewed changes
src/libstd/fs.rs Outdated
/// might change to more specific kinds in the future.
///
/// * `NotFound`: The specified file does not exist and neither `create` or
/// `create_new` is set,
Copy link
Member

Choose a reason for hiding this comment

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

This should end in a period

GuillaumeGomez
GuillaumeGomez reviewed Jun 28, 2017
View reviewed changes
src/libstd/fs.rs Outdated
/// * Invalid combinations of open options (truncate without write access,
/// no access mode set, etc)
/// circumstances. Some of these error conditions are listed here, together
/// with their [`ErrorKind`]. The mapping to `ErrorKind`s is not part of
Copy link
Member

Choose a reason for hiding this comment

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

Missing link to the second ErrorKind.

GuillaumeGomez
GuillaumeGomez requested changes Jun 28, 2017
View reviewed changes
Copy link
Member

@GuillaumeGomez GuillaumeGomez left a comment

Choose a reason for hiding this comment

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

For every type/enum variant, could you add the corresponding url please?

@tbu-
Copy link
Contributor Author

tbu- commented Jun 28, 2017

Added the URLs.

I had to look at the HTML source in order to find the right links, should I open a rustdoc bug about that?

@GuillaumeGomez
Copy link
Member

There is a RFC incoming in order to make links easier to write.

@GuillaumeGomez
Copy link
Member

Thanks!

@bors: r+ rollup

@bors
Copy link
Contributor

bors commented Jun 28, 2017

📌 Commit 2783d0f has been approved by GuillaumeGomez

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request Jun 28, 2017
@Mark-Simulacrum
Rollup merge of rust-lang#42925 - tbu-:pr_document_file_open_errors, …
9cd077a 
…r=GuillaumeGomez

Document possible `io::ErrorKind`s of `fs::open`

Try to make clear that this isn't an API guarantee for now, as we likely
want to refine these errors in the future, e.g. `ENOSPC` "No space left
on device".

CC rust-lang#40322
@Mark-Simulacrum Mark-Simulacrum mentioned this pull request Jun 28, 2017
Closed
@aidanhs aidanhs 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 Jun 28, 2017
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Jun 29, 2017
@frewsxcv
Rollup merge of rust-lang#42925 - tbu-:pr_document_file_open_errors, …
f7c5abf 
…r=GuillaumeGomez

Document possible `io::ErrorKind`s of `fs::open`

Try to make clear that this isn't an API guarantee for now, as we likely
want to refine these errors in the future, e.g. `ENOSPC` "No space left
on device".

CC rust-lang#40322
@frewsxcv frewsxcv mentioned this pull request Jun 29, 2017
Closed
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Jun 29, 2017
@frewsxcv
Rollup merge of rust-lang#42925 - tbu-:pr_document_file_open_errors, …
37a75fd 
…r=GuillaumeGomez

Document possible `io::ErrorKind`s of `fs::open`

Try to make clear that this isn't an API guarantee for now, as we likely
want to refine these errors in the future, e.g. `ENOSPC` "No space left
on device".

CC rust-lang#40322
@frewsxcv frewsxcv mentioned this pull request Jun 29, 2017
Closed
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Jun 30, 2017
@frewsxcv
Rollup merge of rust-lang#42925 - tbu-:pr_document_file_open_errors, …
217bd32 
…r=GuillaumeGomez

Document possible `io::ErrorKind`s of `fs::open`

Try to make clear that this isn't an API guarantee for now, as we likely
want to refine these errors in the future, e.g. `ENOSPC` "No space left
on device".

CC rust-lang#40322
@frewsxcv frewsxcv mentioned this pull request Jun 30, 2017
Closed
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jun 30, 2017
@GuillaumeGomez
Rollup merge of rust-lang#42925 - tbu-:pr_document_file_open_errors, …
7b7962d 
…r=GuillaumeGomez

Document possible `io::ErrorKind`s of `fs::open`

Try to make clear that this isn't an API guarantee for now, as we likely
want to refine these errors in the future, e.g. `ENOSPC` "No space left
on device".

CC rust-lang#40322
@GuillaumeGomez GuillaumeGomez mentioned this pull request Jun 30, 2017
Closed
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jun 30, 2017
@GuillaumeGomez
Rollup merge of rust-lang#42925 - tbu-:pr_document_file_open_errors, …
6cc33dd 
…r=GuillaumeGomez

Document possible `io::ErrorKind`s of `fs::open`

Try to make clear that this isn't an API guarantee for now, as we likely
want to refine these errors in the future, e.g. `ENOSPC` "No space left
on device".

CC rust-lang#40322
@GuillaumeGomez GuillaumeGomez mentioned this pull request Jun 30, 2017
Closed
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jun 30, 2017
@GuillaumeGomez
Rollup merge of rust-lang#42925 - tbu-:pr_document_file_open_errors, …
995f063 
…r=GuillaumeGomez

Document possible `io::ErrorKind`s of `fs::open`

Try to make clear that this isn't an API guarantee for now, as we likely
want to refine these errors in the future, e.g. `ENOSPC` "No space left
on device".

CC rust-lang#40322
@GuillaumeGomez GuillaumeGomez mentioned this pull request Jun 30, 2017
Closed
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jun 30, 2017
@GuillaumeGomez
Rollup merge of rust-lang#42925 - tbu-:pr_document_file_open_errors, …
db004d4 
…r=GuillaumeGomez

Document possible `io::ErrorKind`s of `fs::open`

Try to make clear that this isn't an API guarantee for now, as we likely
want to refine these errors in the future, e.g. `ENOSPC` "No space left
on device".

CC rust-lang#40322
@GuillaumeGomez GuillaumeGomez mentioned this pull request Jun 30, 2017
Merged
bors added a commit that referenced this pull request Jun 30, 2017
@bors
Auto merge of #42995 - GuillaumeGomez:rollup, r=GuillaumeGomez
7d89b20 
Rollup of 6 pull requests

- Successful merges: #42669, #42911, #42925, #42957, #42985, #42987
- Failed merges: #42936
@bors bors merged commit 2783d0f into rust-lang:master Jul 1, 2017
@arielb1 arielb1 mentioned this pull request Aug 17, 2017
Closed
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

@GuillaumeGomez GuillaumeGomez GuillaumeGomez approved these changes

Assignees

@GuillaumeGomez GuillaumeGomez

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.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@tbu- @arielb1 @GuillaumeGomez @bors @frewsxcv @aidanhs @sfackler