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

fix: proper env variable naming #69

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

AuHau
Copy link
Member

@AuHau AuHau commented Mar 21, 2023

This fixes the way how the env. variables names are defined from the parameter names. Especially it follows the convention of using solely uppercase letters, digits, and the '_' (underscore) as specified in IEEE spec.

While the env. variables are currently not wired to be used automatically if somebody used the Envvar manually, then for them merging this PR would be breaking change, yet IMHO, the current implementation is broken and not possible to use as, for example, my shell (fish) does not even allow me to define env. variable with names containing -.

Btw. I am Nim novice so if you have some code improvement suggestions, please let me know ;-)

Closes #68
Closes #21

@zah
Copy link
Contributor

zah commented Mar 22, 2023

I welcome this addition, but can you please document this behavior in the README? You can also include a link the IEEE spec in the code.

@AuHau
Copy link
Member Author

AuHau commented Mar 22, 2023

Will do! Actually found a bug in this PR, so will fix that and adjust the Readme 👍

@AuHau
Copy link
Member Author

AuHau commented Mar 22, 2023

@zah done ;-)

I have also taken the liberty to adjust the README a bit to communicate the library's current capabilities better.

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.

Add warning to readme Example how to use env. variables
2 participants