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

Style for parameter files and documentation of parameters #24

Open
pgrete opened this issue Feb 14, 2023 · 1 comment
Open

Style for parameter files and documentation of parameters #24

pgrete opened this issue Feb 14, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request style

Comments

@pgrete
Copy link
Contributor

pgrete commented Feb 14, 2023

Following up from https://gitlab.com/theias/hpc/jmstone/athena-parthenon/athenapk/-/issues/6 it might be good to discuss a common style for parameter file (e.g., handling of units)

https://gitlab.com/theias/hpc/jmstone/athena-parthenon/athenapk/-/issues/3 is also related, i.e., to add a sample input file (or documentation) containing all options.

@pgrete pgrete added the enhancement New feature or request label Feb 14, 2023
@pgrete pgrete changed the title Units and style for parameter files Style for parameter files and documentation of parameters Feb 14, 2023
@pgrete pgrete added documentation Improvements or additions to documentation style labels Feb 14, 2023
@forrestglines
Copy link
Contributor

Reminder to also address convention for none/None/NONE/DISABLED and capitalization of such

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request style
Projects
None yet
Development

No branches or pull requests

2 participants