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

Add documentation to explain the use of _m notation to identify a member of a class #114

Open
Bai-Li-NOAA opened this issue Oct 20, 2023 · 1 comment
Assignees
Labels
P2 Mid-level priority task
Milestone

Comments

@Bai-Li-NOAA
Copy link
Contributor

We should include documentation within the collaborative workflow document explaining the use of "_m" notation to ensure clarity for both users and developers. Please refer to the comment here for more information.

@Bai-Li-NOAA Bai-Li-NOAA self-assigned this Jan 29, 2024
@Bai-Li-NOAA Bai-Li-NOAA added the P2 Mid-level priority task label Jan 29, 2024
@Bai-Li-NOAA Bai-Li-NOAA added this to the M2 milestone Jan 29, 2024
@JonBrodziak JonBrodziak changed the title Add documentation to explain the use of _m notation Add documentation to explain the use of _m notation to identify a member of a class Jan 29, 2024
@kellijohnson-NOAA
Copy link
Collaborator

The *_m() functions should not be used on the daily, instead they are meant to be accessors used by internal FIMS functions. I noticed that not all of the functions are documented. Their use does not need to be documented in the collaborative workflow guide because once the wrapper function is written it will be clear how to use them for power users.

  • The R interface group will make sure that they are all documented using roxygen and before this issue is closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P2 Mid-level priority task
Projects
Status: In Progress
Development

No branches or pull requests

2 participants