Skip to content

Minor improvements to docs in std::env structures/functions. #39028

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
Jan 17, 2017
Merged
Changes from all commits
Commits
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
20 changes: 12 additions & 8 deletions src/libstd/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

//! Inspection and manipulation of the process's environment.
//!
//! This module contains methods to inspect various aspects such as
//! This module contains functions to inspect various aspects such as
//! environment variables, process arguments, the current directory, and various
//! other important directories.

Expand Down Expand Up @@ -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.
Copy link
Member

@nagisa nagisa Jan 13, 2017

Choose a reason for hiding this comment

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

Previous sentence was strictly more informative IMO.

Copy link
Member Author

Choose a reason for hiding this comment

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

How so? "yields (String, String) pairs." isn't saying anything more than what's displayed in the Iterator section of Env.

Copy link
Member

Choose a reason for hiding this comment

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

Oh, never mind me, I totally thought this was documentation for the function, which hasn’t such information displayed.

///
/// [`std::env::vars`]: fn.vars.html
#[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.
Copy link
Member

Choose a reason for hiding this comment

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

Ditto here.

///
/// [`std::env::vars_os`]: fn.vars_os.html
#[stable(feature = "env", since = "1.0.0")]
pub struct VarsOs { inner: os_imp::Env }

Expand Down Expand Up @@ -218,7 +220,9 @@ fn _var_os(key: &OsStr) -> Option<OsString> {
})
}

/// Possible errors from the `env::var` method.
/// Possible errors from the [`env::var`] function.
///
/// [env::var]: fn.var.html
#[derive(Debug, PartialEq, Eq, Clone)]
#[stable(feature = "env", since = "1.0.0")]
pub enum VarError {
Expand Down Expand Up @@ -570,7 +574,7 @@ pub fn current_exe() -> io::Result<PathBuf> {
/// An iterator over the arguments of a process, yielding a [`String`] value
/// for each argument.
///
/// This structure is created through the [`std::env::args`] method.
/// This structure is created through the [`std::env::args`] function.
///
/// [`String`]: ../string/struct.String.html
/// [`std::env::args`]: ./fn.args.html
Expand All @@ -580,7 +584,7 @@ pub struct Args { inner: ArgsOs }
/// An iterator over the arguments of a process, yielding an [`OsString`] value
/// for each argument.
///
/// This structure is created through the [`std::env::args_os`] method.
/// This structure is created through the [`std::env::args_os`] function.
///
/// [`OsString`]: ../ffi/struct.OsString.html
/// [`std::env::args_os`]: ./fn.args_os.html
Expand Down