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

Documenting each cmod_x.cpp with description of purpose #298

Open
dguittet opened this issue Jul 29, 2019 · 0 comments
Open

Documenting each cmod_x.cpp with description of purpose #298

dguittet opened this issue Jul 29, 2019 · 0 comments

Comments

@dguittet
Copy link
Collaborator

dguittet commented Jul 29, 2019

Is your feature request related to a problem? Please describe.
Within each cmod_x.cpp compute_module, the inputs and outputs are described in the var_info table. While the descriptions are minimal, they offer info for HOW to use the module. However, the purpose of the compute_module itself is not documented in the file, and makes it difficult to figure out WHAT it is used for.

Describe the solution you'd like
A clear and descriptive comment above the var_info table documenting the module's purpose.

Currently, the description is a brief statement at the bottom of the page, ie:

DEFINE_MODULE_ENTRY( 6parsolve, "Solver for CEC/6 parameter PV module coefficients", 1 )
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant