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.

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

R6 documentation #154

Open
3 of 7 tasks
jmbarbone opened this issue Apr 30, 2022 · 0 comments
Open
3 of 7 tasks

R6 documentation #154

jmbarbone opened this issue Apr 30, 2022 · 0 comments
Labels
documentation ✍️ Improvements or additions to documentation help wanted 🙏 Extra attention is needed R6 6️⃣

Comments

@jmbarbone
Copy link
Collaborator

jmbarbone commented Apr 30, 2022

We (I) have been pretty lazy with the documentation. These current docs are written just so roxygen doesn't complain.

  • ensure R6 object methods match documentation for wrappers
    • There are some warnings for the R6 documentation that we might be able to ignore them
    • I don't want to copy over documentation but there may be some duplicated because of the wrappers
  • Simplify examples to mostly bare minimal
    • Enough to get a gist of the function
    • We can be a bit more creative with vignettes without bogging down the documentation
    • Examples are currently shown in wrapper functions only.
  • Review formatting
  • Review @family tags (can probably group a few)
  • Maintain @return tags (for most R6 it will be "The wbWorkbook object"
  • Consider simplify names
  • Consider moving public fields to private
@jmbarbone jmbarbone added documentation ✍️ Improvements or additions to documentation R6 6️⃣ labels Apr 30, 2022
@JanMarvin JanMarvin added this to the v1.0.0 - CRAN release milestone Apr 30, 2022
@jmbarbone jmbarbone added the help wanted 🙏 Extra attention is needed label May 2, 2022
@olivroy olivroy removed this from the v1.0.0 - CRAN release milestone Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation ✍️ Improvements or additions to documentation help wanted 🙏 Extra attention is needed R6 6️⃣
Projects
None yet
Development

No branches or pull requests

3 participants