Updating some of the documentation #1
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
Prior to this change the initial definition for the esteq documentation had the tag `@name est_eq` but all the functions used `@rdname esteq`. The result was inconsistent documentation and missing references in the NAMESPCE. This change chagnes the roxygen comment to `@name esteq` and updates all documentation files.
Prior to this change Y1 was documented as functional arguement but not part of the function definition. R CMD check identified Y1 as a undefined global variable as a result. I suspect no errors were thrown during testing because the any use of Y1 in a call would be captured by the `...` argument. This change add Y1 explicitly to the function arguments.
This was referenced Jul 1, 2020
Closed
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.
These changes update most of the documentation. There is more to do, additional issues are going to be filed to document additional work to be done, but these changes were quick and easy and will be a good starting point.