Skip to content

Update ChildStderr docs to be clearer #40829

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

Merged
merged 2 commits into from
Apr 9, 2017
Merged

Update ChildStderr docs to be clearer #40829

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d59c67
Update ChildStderr docs to be clearer
mgattozzi Mar 25, 2017
c7f2dbe
Change docs to follow review requests
mgattozzi Apr 4, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/libstd/process.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,9 @@ impl fmt::Debug for ChildStdout {
}
}

/// A handle to a child process's stderr. This struct is used in the [`stderr`]
/// field on [`Child`].
/// A handle to a child process's stderr. It can be used to
Copy link
Member

Choose a reason for hiding this comment

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

So what we need is a newline between this sentence and the next. rustdoc treats the first paragraph as the summary so

/// A handle to a child process' stderr.
///
/// It can be used to....

that kind of thing. make sense?

Copy link
Member

Choose a reason for hiding this comment

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

I'd prefer to have it this way as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ahhhh okay got it.

Copy link
Member

Choose a reason for hiding this comment

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

Please keep "This struct is used in the [stderr] field on [Child]."

Copy link
Member

Choose a reason for hiding this comment

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

I'm not saying to remove it, I'm saying that there needs to be whitespace between.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay will do. That makes more sense.

/// read any errors that the child process has output while
/// running.
///
/// [`Child`]: struct.Child.html
/// [`stderr`]: struct.Child.html#structfield.stderr
Expand Down