Improve wbWorkbook documentation.
#718
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 tasks
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Addresses #681.
The reason why the documentation did not render properly for
wbWorkbookis because of issues in roxygen2. namely r-lib/roxygen2#1148 and r-lib/roxygen2#1504The documentation for
wbWorkbookandwbChartSheetlooks much better after this PR.I looked at how processx documents its
processR6 Class.https://github.com/r-lib/processx/blob/main/man/process.Rd and https://github.com/r-lib/processx/blob/main/R/process.R for the record.
Edit: the changes in the R files could be reverted once the roxygen2 fixes are made.
The
wbWorkbookdocs could be even cleaner if some documentation of fields was removed ? i.e. see methods first? Also could add links to vignettes on how to use it, although, it is mentioned in many places, how to use the R6 methods,wb$addetc. (for amother PR or issue if relevant)