Added a new paragraph to the ?restore docs describing the heuristic. Link to ?restore from the ?bundle documentation. From a scan of the code, these were the two documented functions that wind up tarring or untarring things — some but not all of which happened automatically when calling devtools::document().
Intent
Better document TAR binary discovery heuristic.
Resolves #689
Approach
Added a new paragraph to the
?restore
docs describing the heuristic. Link to?restore
from the?bundle
documentation. From a scan of the code, these were the two documented functions that wind up tarring or untarring things — some but not all of which happened automatically when callingdevtools::document()
.Some reflowing of roxygen comments.
QA
Documentation-only change, so none / CI.