Minor improvements to docs in std::env structures/functions. #39028
Conversation
frewsxcv
commented
Jan 13, 2017
frewsxcv
commented
- Call functions "functions" instead of "methods".
- Link structures to their constructor functions
- Add other misc. documentation links
* Call functions "functions" instead of "methods". * Link structures to their constructor functions * Add other misc. documentation links
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @brson (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
| @@ -68,15 +68,17 @@ pub fn set_current_dir<P: AsRef<Path>>(p: P) -> io::Result<()> { | |||
|
|
|||
| /// An iterator over a snapshot of the environment variables of this process. | |||
| /// | |||
| /// This iterator is created through `std::env::vars()` and yields `(String, | |||
| /// String)` pairs. | |||
| /// This structure is created through the [`std::env::vars`] function. | |||
There was a problem hiding this comment.
Previous sentence was strictly more informative IMO.
There was a problem hiding this comment.
How so? "yields (String, String) pairs." isn't saying anything more than what's displayed in the Iterator section of Env.
There was a problem hiding this comment.
Oh, never mind me, I totally thought this was documentation for the function, which hasn’t such information displayed.
| #[stable(feature = "env", since = "1.0.0")] | ||
| pub struct Vars { inner: VarsOs } | ||
|
|
||
| /// An iterator over a snapshot of the environment variables of this process. | ||
| /// | ||
| /// This iterator is created through `std::env::vars_os()` and yields | ||
| /// `(OsString, OsString)` pairs. | ||
| /// This structure is created through the [`std::env::vars_os`] function. |
|
r=me whenever @nagisa is satisfied |
|
LGTM. |
|
@bors r=brson |
|
📌 Commit 58a470e has been approved by |
|
@bors rollup |
|
⌛ Testing commit 58a470e with merge 41d6fc3... |
|
💔 Test failed - status-travis |
|
… On Mon, Jan 16, 2017 at 8:01 AM, bors ***@***.***> wrote:
💔 Test failed - status-travis
<https://travis-ci.org/rust-lang/rust/builds/192399982>
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#39028 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AAD95H0-GgZx2PGMcgSf_p3kzOJ-pMFcks5rS5RhgaJpZM4LighM>
.
|
Minor improvements to docs in std::env structures/functions. * Call functions "functions" instead of "methods". * Link structures to their constructor functions * Add other misc. documentation links
