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

docs: improve clarity of dotenv setup #3169

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ethan-sargent
Copy link

Clarifies documentation by linking to dotenvy.
Removes the superscript note recommending the use of dotenvy as it is now the
linked repository.
This also ensures users are linked to maintained documentation
and avoids confusion as in allan2/dotenvy#92.

depends on allan2/dotenvy#98
fixes #3168
resolves root cause of allan2/dotenvy#92

- updates dotenv crate link to dotenvy (maintained fork)
- removes unneeded superscript note
@abonander
Copy link
Collaborator

You probably want to get this mention in the macro docs as well: https://github.com/launchbadge/sqlx/blob/main/src/macros/mod.rs#L56

@ethan-sargent
Copy link
Author

ethan-sargent commented Apr 3, 2024

Thanks @abonander - done. Looked for any other references but didn't spot any.

Updated the footnote names (neat trick!) to dotenvy for consistency as well.

edit: fixed an issue with the commit message – let me know if you want them squashed

- removes additional reference in macros documentation
- updates url footnotes to dotenvy for consistency
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation links to unmaintained dotenv repo
2 participants