docs: Document package options #1193
Conversation
|
This is how benchmark results would change (along with a 95% confidence interval in relative change) if 9416b3b is merged into main:
Further explanation regarding interpretation and methodology can be found in the documentation. |
There was a problem hiding this comment.
Good start, a few suggestions to improve things further. I think {pkgdown} should pick up these if you stick to the suggested syntax, according to the docs.
R/options.R
Outdated
| #' | ||
| #' - `styler.cache_name`: character. | ||
| #' The name of the styler cache to use. | ||
| #' (default: current styler package version) |
There was a problem hiding this comment.
We could actually put the version here, since roxygen comments can now contain R code to evaluate.
| #' | ||
| #' - `styler.cache_root`: character. | ||
| #' The directory where the cache files are stored. | ||
| #' (default: `NULL`) |
There was a problem hiding this comment.
I think we could link help("caching") here.
| #' | ||
| #' - `styler.ignore_alignment`: logical. | ||
| #' If `TRUE`, alignment, when detected, is ignored. | ||
| #' (default: `FALSE`) |
There was a problem hiding this comment.
I think we could link vignette("detect-alignment") here.
| #' | ||
| #' - `styler.ignore_start`, `styler.ignore_stop`: character. | ||
| #' Regular expressions to ignore lines that match them. | ||
| #' (default: `"styler: off"` and `"styler: on"`, respectively) |
There was a problem hiding this comment.
I think we can link help("stylerignore") here.
|
This is how benchmark results would change (along with a 95% confidence interval in relative change) if 9416b3b is merged into main:
Further explanation regarding interpretation and methodology can be found in the documentation. |
|
Thanks. Great addition to our docs. |
Closes #1185