Skip to content

Commit

Permalink
Merge pull request #6 from KevinMGranger/doc_links
Browse files Browse the repository at this point in the history
Use doc links for docs that reference other items
  • Loading branch information
Allan authored Jul 18, 2022
2 parents 24890e8 + c408900 commit f6c92fb
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions dotenv/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ pub fn from_path<P: AsRef<Path>>(path: P) -> Result<()> {
iter.load()
}

/// Like `from_path`, but returns an iterator over variables instead of loading into environment.
/// Like [from_path], but returns an iterator over variables instead of loading into environment.
///
/// Examples
///
Expand All @@ -105,7 +105,7 @@ pub fn from_path_iter<P: AsRef<Path>>(path: P) -> Result<Iter<File>> {
/// dotenvy::from_filename("custom.env").ok();
/// ```
///
/// It is also possible to do the following, but it is equivalent to using `dotenvy::dotenv()`,
/// It is also possible to do the following, but it is equivalent to using [dotenv],
/// which is preferred.
///
/// ```
Expand All @@ -117,14 +117,14 @@ pub fn from_filename<P: AsRef<Path>>(filename: P) -> Result<PathBuf> {
Ok(path)
}

/// Like `from_filename`, but returns an iterator over variables instead of loading into environment.
/// Like [from_filename], but returns an iterator over variables instead of loading into environment.
///
/// # Examples
/// ```
/// dotenvy::from_filename("custom.env").ok();
/// ```
///
/// It is also possible to do the following, but it is equivalent to using `dotenvy::dotenv()`,
/// It is also possible to do the following, but it is equivalent to using [dotenv_iter],
/// which is preferred.
///
/// ```no_run
Expand Down Expand Up @@ -153,7 +153,7 @@ pub fn dotenv() -> Result<PathBuf> {
Ok(path)
}

/// Like `dotenv`, but returns an iterator over variables instead of loading into environment.
/// Like [dotenv], but returns an iterator over variables instead of loading into environment.
///
/// # Examples
/// ```no_run
Expand Down

0 comments on commit f6c92fb

Please sign in to comment.