[Developer Issue]: Documenting things using Rcpp or C++ #635
Labels
kind: documentation
Improvements or additions to documentation
kind: question
Further information is requested
P2
mid-level priority
status: needs discussion
Dialogue is needed before a decision can be made.
theme: documentation
Milestone
We should document units alongside code but which method of doing that is unclear. Below are options and some questions
Should we document units alongside the C++ code and display them on the Doxygen website (e.g., updating the documentation near log_rzero to include the units
https://github.com/NOAA-FIMS/FIMS/blob/main/inst/include/population_dynamics/recruitment/functors/recruitment_base.hpp#L42
Should we document units in the Rcpp interface following approach 4 listed here? For example, we can document units in the age comp data interface:
Then user can view the documentation in R
Originally posted by @Bai-Li-NOAA in #561 (comment)
The text was updated successfully, but these errors were encountered: