Modify Roxygen directives and NAMESPACE header to ensure devtools::document() produces consistent results #4518
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
alexpeters1208
added
NoDocumentationNeeded
NoReleaseNotesNeeded
chipkent
approved these changes
Sep 19, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
In order to ensure that running
devtools::documentI()on the R client does not break anything, we have to remove the autogenerated directive at the top of the NAMESPACE file. Otherwise,devtools::document()will mangle our NAMESPACE file according to Roxygen directives, but we do not use those directives in exactly the standard way, so this would break our package. Additionally, runningdevtools::document()would, at the moment, deleteClient.RdandTableHandle.Rd, which were merged on their own without the roxygen directives for creating them. So, this PR includes those directives.All this PR really does is ensure that running
devtools::document()orroxygen2::roxygenize()on main will not break the package. This will likely change again when the doc pages are not generated from roxygen comments tied to R6 classes.