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

Undocumented interfaces in config_src/external/Icepack_interfaces #149

Open
Hallberg-NOAA opened this issue Jun 2, 2021 · 0 comments
Open

Comments

@Hallberg-NOAA
Copy link
Member

The code that was imported from Icepack to provide interfaces for SIS2 to use when the Icepack code is not available violates the MOM6/SIS2 coding standards with regards to documentation and how modules are accessed. Although the module use issues can not be addressed without also modifying Icepack, there is no excuse for not adequately documenting the interfaces in the code in the SIS2 repository. Specifically,

  1. A large number of subroutine arguments are not described in comments, and none of them use Doxygen syntax.
  2. The units of a number of real variables are not documented.
    Both of these should be corrected in the code in confic_src/external/Icepack_interfaces.
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