Skip to content

Commit

Permalink
Merge pull request rust-cli#481 from ijackson/warning
Browse files Browse the repository at this point in the history
Fix docs warnings
  • Loading branch information
matthiasbeyer authored Oct 23, 2023
2 parents 8e4fb6f + 11adf43 commit 1887369
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ pub struct Environment {
/// Optional character sequence that separates each env value into a vector. only works when try_parsing is set to true
/// Once set, you cannot have type String on the same environment, unless you set list_parse_keys.
list_separator: Option<String>,
/// A list of keys which should always be parsed as a list. If not set you can have only Vec<String> or String (not both) in one environment.
/// A list of keys which should always be parsed as a list. If not set you can have only `Vec<String>` or `String` (not both) in one environment.
list_parse_keys: Option<Vec<String>>,

/// Ignore empty env values (treat as unset).
Expand Down Expand Up @@ -142,7 +142,9 @@ impl Environment {
}

/// When set and try_parsing is true, then all environment variables will be parsed as [`Vec<String>`] instead of [`String`].
/// See [`with_list_parse_key`] when you want to use [`Vec<String>`] in combination with [`String`].
/// See
/// [`with_list_parse_key`](Self::with_list_parse_key)
/// when you want to use [`Vec<String>`] in combination with [`String`].
pub fn list_separator(mut self, s: &str) -> Self {
self.list_separator = Some(s.into());
self
Expand Down

0 comments on commit 1887369

Please sign in to comment.