shiny.semantic
shiny.semantic copied to clipboard
Use roxygen markdown for help documentation
This changes the help documentation to use roxygen markdown, since this is in general easier to write and maintain.
In addition, moves documentation examples into inst/examples/___.R - this makes it easier to edit documentation examples, since you can run the R code directly.
DoD
-
[ ] Major project work has a corresponding task. If there’s no task for what you are doing, create it. Each task needs to be well defined and described.
-
[x] Change has been tested (manually or with automated tests), everything runs correctly and works as expected. No existing functionality is broken.
-
[x] No new error or warning messages are introduced.
-
[x] All interaction with a semantic functions, examples and docs are written from the perspective of the person using or receiving it. They are understandable and helpful to this person.
-
[x] If the change affects code or repo sctructure, README, documentation and code comments should be updated.
-
[ ] All code has been peer-reviewed before merging into any main branch.
-
[ ] All changes have been merged into the main branch we use for development (develop).
-
[ ] Continuous integration checks (linter, unit tests) are configured and passed.
-
[ ] Unit tests added for all new or changed logic.
-
[ ] All task requirements satisfied. The reviewer is responsible to verify each aspect of the task.
-
[ ] Any added or touched code follows our style-guide.