Skip to content

Commit

Permalink
Rollup merge of rust-lang#125206 - mgeisler:simplify-std-env-vars, r=…
Browse files Browse the repository at this point in the history
…jhpratt,tgross35

Simplify environment variable examples

I’ve found myself visiting the documentation for `std::env::vars` every few months, and every time I do, it is because I want to quickly get a snippet to print out all environment variables :-)

So I think it could be nice to simplify the examples a little to make them self-contained. It is of course a style question if one should import a module a not, but I personally don’t import modules used just once in a code snippet.
  • Loading branch information
tgross35 authored Jul 17, 2024
2 parents 5e4edba + ce29159 commit 8490c84
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions std/src/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,8 @@ pub struct VarsOs {
/// # Examples
///
/// ```
/// use std::env;
///
/// // We will iterate through the references to the element returned by
/// // env::vars();
/// for (key, value) in env::vars() {
/// // Print all environment variables.
/// for (key, value) in std::env::vars() {
/// println!("{key}: {value}");
/// }
/// ```
Expand All @@ -150,11 +147,8 @@ pub fn vars() -> Vars {
/// # Examples
///
/// ```
/// use std::env;
///
/// // We will iterate through the references to the element returned by
/// // env::vars_os();
/// for (key, value) in env::vars_os() {
/// // Print all environment variables.
/// for (key, value) in std::env::vars_os() {
/// println!("{key:?}: {value:?}");
/// }
/// ```
Expand Down

0 comments on commit 8490c84

Please sign in to comment.