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): Write user-centric documentation #54

Closed
wants to merge 2 commits into from
Closed

fix(docs): Write user-centric documentation #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ba627b
fix(docs): Write user-centric documentation
LeoniePhiline Dec 11, 2022
ee228b4
task: Add changes to `CHANGELOG.md`
LeoniePhiline Dec 11, 2022
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

- Minimum Supported Rust Version is now 1.56.1
- Removed internal `dotenv_codegen_impl` crate and `proc_macro_hack` dependency
- Rewrote most documentation ([PR #54](https://github.com/allan2/dotenvy/pull/54) by [LeoniePhiline](https://github.com/LeoniePhiline)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you be more specific as to how the documentation was changed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what you mean. What would you propose? Something like the list at the top of this PR? This seems a little verbose to me. This is a changelog - users commonly don't use it to find out which documentation was changed in detail, but rather which type interface and behavior changes affect them.


## [0.15.6] - 2022-10-17

Expand Down
12 changes: 12 additions & 0 deletions dotenv/src/iter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ impl<R: Read> Iter<R> {
///
/// If a variable is specified multiple times within the reader's data,
/// then the first occurrence is applied.
///
/// # Errors
///
/// An [`Error::Io`] is returned if the provided `reader` is not readable.
///
/// An [`Error::LineParse`] is returned if the provided `reader` produces invalid declarations.
pub fn load(mut self) -> Result<()> {
self.remove_bom()?;

Expand All @@ -44,6 +50,12 @@ impl<R: Read> Iter<R> {
///
/// If a variable is specified multiple times within the reader's data,
/// then the last occurrence is applied.
///
/// # Errors
///
/// An [`Error::Io`] is returned if the provided `reader` is not readable.
///
/// An [`Error::LineParse`] is returned if the provided `reader` produces invalid declarations.
pub fn load_override(mut self) -> Result<()> {
self.remove_bom()?;

Expand Down
Loading