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

Unorthodox params.py #8

Open
jcohenadad opened this issue May 15, 2022 · 0 comments
Open

Unorthodox params.py #8

jcohenadad opened this issue May 15, 2022 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jcohenadad
Copy link
Member

The README asks to edit the file params.py and then run the code, which fetches the modified file. This is a bit unorthodox, because modifying the source code will create out-of-sync versions from the git repository, which could cause errors/confusions.

A better approach would be to ask the user to copy params.py into another file that would not be under git, edit it and then run the code.

To facilitate the transition with minimum code surgery, we could rename the current params.py into params_template.py, and ask user to create a file params.py

@jcohenadad jcohenadad added help wanted Extra attention is needed good first issue Good for newcomers labels Jun 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant