-
Notifications
You must be signed in to change notification settings - Fork 8
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
Migrate documentation to roxygen2 #61
Merged
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
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.
Noting some inconsistencies/gaps for which I couldn't find a workaround, and intentional splits:
NA_integer64_
gets some extra metadata Disable behavior of @export to _always_ treat a non-function as a "data" documentation roxygen2#1666@describeIn
puts those annotations in a\section{Functions}
instead of the\description{}
**text**
translates to\strong{text}
, not\bold{text}
, AFAICT there's not too much meaningful differenceis.integer64
was being documented as an S3 method (it's not registered as such in NAMESPACE); probably this is a relic of 1d34b37:bit64/man/bit64-package.Rd
Line 55 in a014e88
bit64/NAMESPACE
Lines 371 to 373 in a014e88
%in%
was not properly escaped and we wound up with unintentionally-commented exposition (note the awkward'
):bit64/man/bit64-package.Rd
Line 36 in a014e88
\details{...}
section from bit64-package which does not add much and is already way out of date:bit64/man/bit64-package.Rd
Lines 79 to 89 in d783d63
Some code to compare NAMESPACE across branches (normalizing away trivial differences like sort order):