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.

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

Use doc links for docs that reference other items #6

Merged
merged 1 commit into from
Jul 18, 2022
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
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