Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Make individual topics more discoverable in documentation #277

Open
10 tasks
klmr opened this issue May 16, 2022 · 0 comments
Open
10 tasks

Make individual topics more discoverable in documentation #277

klmr opened this issue May 16, 2022 · 0 comments
Assignees
@klmr
Labels
📚 documentation ⚙️ enhancement

Comments

@klmr
Copy link
Owner

klmr commented May 16, 2022 •
edited

Things like

  • ‘roxygen2’ documentation
  • support for testing
  • support for FFI
  • module implementation details
    • imports (lack of attached core R packges, r/core …)
    • using modules as application entry points (box::name())
    • Module search path
    • Export specification
  • ‘box’ options/environment variables
  • …

should have individual entries in the documentation index to be more discoverable. Vignettes are great but no substitute for this. Neither is the FAQ, or sections inside the box:use() man page.

See also https://twitter.com/rmflight/status/1526192221720137731.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@klmr klmr

Labels
📚 documentation ⚙️ enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@klmr