Skip to content

Improve vignette variable naming, patterns, dependencies on data-raw #248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
brookslogan opened this issue Nov 16, 2022 · 2 comments
Closed
Labels
cleanup improvements to developing&building experience&quality, not directly to built pkg&docs documentation Improvements or additions to documentation P2 low priority

Comments

@brookslogan
Copy link
Contributor

brookslogan commented Nov 16, 2022

Debugging vignette errors is a made more difficult by:

  • non-explanatory variable naming
  • eval=FALSE chunks that have fallen out of sync with the actual data being extracted from objects in data-raw
  • bindings being overwritten, so repeating error behavior sometimes repeating the initial binding + some rebindings while avoiding eval=FALSE chunks

Improve vignette variable naming while reducing the amount of binding&object mutation that occurs. Add a development guide and/or notes in data-raw that instruct developers to update vignettes accordingly whenever updating data-raw scripts.

Also consider turning echo=FALSE chunks loading data objects into visible chunks with an explanation for the reader. (So they can run things more quickly.)

@brookslogan brookslogan added documentation Improvements or additions to documentation P3 very low priority cleanup improvements to developing&building experience&quality, not directly to built pkg&docs labels Nov 16, 2022
@brookslogan brookslogan added P2 low priority and removed P3 very low priority labels Jan 30, 2023
@brookslogan
Copy link
Contributor Author

Or, for the nonevaluated API + nonechoed data object chunk pairs, consider just eval+echo the chunk using the example data.

@dshemetov
Copy link
Contributor

Going to close this in favor of #363

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup improvements to developing&building experience&quality, not directly to built pkg&docs documentation Improvements or additions to documentation P2 low priority
Projects
None yet
Development

No branches or pull requests

2 participants