Open yichengt900 opened 3 months ago
Hi Yi-Cheng,
I just added a pull request with substantially improved commenting for the irradiance and phytoplankton growth sections. I am hoping that we can discuss the scope of these comments at the next doc and dev meeting. If they are consistent with what people would like to see, perhaps we can shift these toward the inline documentation.
best, Charlie
@charliestock, thank you for the kind notification. Originally, my thought was that all of us could contribute our comments to the feature/inline_documentation
branch, and I could move them later to the main branch. However, considering the frequency of recent updates in the main branch, and since you have already opened a PR, I would suggest that instead of working on the feature/inline_documentation
branch, we can directly put our comments on the main branch and open a PR there. @gabyneg, are you okay with that?
@yichengt900, yes, that sounds good to me!
Now we are starting to use Doxygen for COBALT source code & API documentation . All COBALT subroutines and variables are supposed to have documentation. We will begin adding inline documentation during the COBALTv3 Focused Documentation and Development effort.
Since the current COBALT code contains over 16,000 lines, I suggest we break this issue into multiple steps. For instance, we can start with model parameter documentation first, followed by other components. @charliestock , @gabyneg I will create a feature branch
feature/inline_documentation
under this CEFI ocean_BGC repo, and we can all work on this branch for inline documentation. Any other thoughts are more than welcome!