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

DOC: Add a consistency section to the contributing Guidelines #582

Open
jucordero opened this issue Nov 22, 2022 · 0 comments
Open

DOC: Add a consistency section to the contributing Guidelines #582

jucordero opened this issue Nov 22, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation examples

Comments

@jucordero
Copy link
Contributor

Based on issue #117, we should add instructions on how to be consistent with units, tests, inputs etc. in the documentation and the code.
Some of the modules are intrinsically defined to accept inputs with slightly different formats (e.g. wavenumbers in power spectrum modules), and the tests/examples are seen to use different values and input array sizes.

Expected behavior
A clear and consistent set of assumptions and input values for the different tests and examples.

@jucordero jucordero added documentation Improvements or additions to documentation examples labels Nov 22, 2022
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 examples
Projects
None yet
Development

No branches or pull requests

1 participant