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

Add increased documentation and descriptive variable names #1

Open
texloch opened this issue Feb 6, 2024 · 0 comments
Open

Add increased documentation and descriptive variable names #1

texloch opened this issue Feb 6, 2024 · 0 comments

Comments

@texloch
Copy link

texloch commented Feb 6, 2024

Although the documentation of this project is an improvement from the original Fortran documentation, there is still much left to be desired.

For a model such as this that is often misunderstood or misinterpreted, it is imperative to provide thorough documentation describing not only the purpose of each method, but also the intermediate variables and calculations.

This provides developers, maintainers, and users with a greater ability to explain the model to others (e.g., at a low level to non-technical stakeholders), and to make adjustments as necessary for their specific applications.

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

No branches or pull requests

1 participant