Skip to content

Fix some of the documentation std::io::fs #16052

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

Merged
merged 1 commit into from
Jul 29, 2014
Merged

Conversation

nham
Copy link
Contributor

@nham nham commented Jul 28, 2014

Some of the fixes include:

  • fixing mismatch between the documentation and the function parameters. (i.e. documentation references path parameter, but it's actually called from, or vice versa)

  • A few Error sections were missing an "if" on the middle clause. For example, they used to be: "This function will return an error if [Thing], [Another Thing], or if [Yet Another Thing]." I added an "if" so it becomes "This function will return an error if [Thing], if [Another Thing], or if [Yet Another Thing]"

  • The error sections previously started off with 3 different phrases:

    • "This function will return an error if ..."
    • "Will return an error if ..."
    • "This call will return an error if ..."

    I've standardized on the first phrase.

bors added a commit that referenced this pull request Jul 29, 2014
Some of the fixes include:

 - fixing mismatch between the documentation and the function parameters. (i.e. documentation references `path` parameter, but it's actually called `from`, or vice versa)
 - A few Error sections were missing an "if" on the middle clause. For example, they used to be: "This function will return an error if [Thing], [Another Thing], or if [Yet Another Thing]." I added an "if" so it becomes "This function will return an error if [Thing], if [Another Thing], or if [Yet Another Thing]"
 - The error sections previously started off with 3 different phrases: 

     - "This function will return an error if ..."
     - "Will return an error if ..."
     - "This call will return an error if ..."

  I've standardized on the first phrase.
@bors bors closed this Jul 29, 2014
@bors bors merged commit 96cf011 into rust-lang:master Jul 29, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants