pharmaverse / admiral

ADaM in R Asset Library
https://pharmaverse.github.io/admiral
Apache License 2.0
220 stars 62 forks source link

Clean up documentation on datetime/date flagging functions, e.g. `compute_dtf()`/`compute_tmf()` to make development/maintenance easier #2343

Closed zdz2101 closed 4 months ago

zdz2101 commented 6 months ago

The intuition/documentation behind the code of compute_dtf() and compute_tmf() can be modified to be more "human-readable" and reduce "code smells"

Definition of done:

  1. Add code comments where appropriate
    1. tmf is in need of some help!
  2. Add notes in roxygen documentation such that any "new developer" in the codebase can quickly pickup and contribute
  3. Add context to where and when this function is used
bms63 commented 4 months ago

Current comments and documentation is sufficient. A diagram of the process might be created for future developers to get a hadnle on the situation