Move docs for locations helper into own topic #1658
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR tweaks the docs for the
cells_*()
functions.The idea is that there was duplication.
tab_style()
,tab_footnote()
and the text transformingtext_*()
functions.This removes the description of other
cells_*()
in eachcells*()
topic and moves this to a central location.?location-helper
This adds a couple of cross-refs to the
location-helper
topic to make it easy to preview it easily from the help pane.The reason behind is that you usually don't really want to move between cells_* functions, but rather
tab_*
<->cells_*()
.For fixing
_pkgdown.yml
, I usehas_concept()
(topic matching)Let me know if you like the approach or if you have suggestions on how to further improve it! I tried separating the commits as much as possible!
I am also able to use
@InheritParams
forlocations
and.locations
as roxygen2 understands this pattern.Checklist
I have listed any major changes in the NEWS.I have addedtestthat
unit tests totests/testthat
for any new functionality.