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

.checkNamingConventions() documentation in codeCheck() points to non-existant URL #81

Open
0UmfHxcvx5J7JoaOhFSs5mncnisTJJ6q opened this issue Jan 24, 2024 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@0UmfHxcvx5J7JoaOhFSs5mncnisTJJ6q
Copy link
Member

# https://github.com/magpiemodel/tutorials/blob/master/4_GAMScodeStructure.md#23-coding-etiquette-variable-and-parameter-naming # nolint

And should the gms package not document itself what exactly it is checking, instead of pointing somewhere?
As it stands, the next best things to documentation are the "coding etiquettes" of the MAgPIE and REMIND models, and they differ.
https://github.com/magpiemodel/magpie/blob/fee7e6a916eb5861f4f406b1886fd28430b34de0/main.gms#L107-L110

*' The prefixes have to be extended in some cases by a second letter
*'
*'  * ?m_ module-relevant object - This object is used by at least one module and the core code. Changes related to this object have to be performed carefully.
*'  * ?00_ (a 2-digit number) module-only object This 2-digit number defines the module the object belongs to. The number is used here to make sure that different modules cannot have the same object

https://github.com/remindmodel/remind/blob/6bc0d045141a3a5af894b9925993b0845778f4d2/main.gms#L107-L111

*' These prefixes are extended in some cases by a second letter:
*'
*' * "?m_" to designate objects used in the core and in at least one module.
*' * "?00_" to designate objects used in a single module, exclusively, with the 2-digit number corresponding
*'          to the module number.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants