Skip to content
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

Fix docs warnings #481

Merged
merged 2 commits into from
Oct 23, 2023
Merged

Fix docs warnings #481

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d225a1
Fix a doc link to with_list_parse_key
ijackson Oct 23, 2023
11adf43
Fix a doc link by properly marking Vec<String>
ijackson Oct 23, 2023
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
6 changes: 4 additions & 2 deletions src/env.rs
View file
Open in desktop
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