Documentation Additions to kde #28
Open
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
Specified parameters with roxygen style comments, code functionality also outlined
dlm
requested changes
Feb 23, 2019
R/kde.R
Outdated
| @@ -26,7 +34,7 @@ function(X, Grid, h, kertype = "Gaussian", weight = 1, printProgress = FALSE) { | |||
| if (!is.logical(printProgress)) { | |||
| stop("printProgress should be a logical variable") | |||
| } | |||
|
|
|||
| # utilize Kde function with inputs | |||
There was a problem hiding this comment.
Remove comment. Generally, it is better to use comments to explain code that is hard to understand. In this case, the comment doesn't provide any additional value.
R/kde.R
Outdated
| function(X, Grid, h, kertype = "Gaussian", weight = 1, printProgress = FALSE) { | ||
|
|
||
| # exception handling of inputs to ensure functionality |
There was a problem hiding this comment.
Let's remove also for a somewhat similar comment to below. Although this comment does provide some additional information to the actual code, almost all of the functions in the package do some precondition checking. Since each function is doing some checks, we would end up having the same comments everywhere.
Removed unnecessary comments for kde function as requested
Roxygen comments have to be outside function, and needed a title to render properly. Added return value as well.
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.
Specified parameters with roxygen style comments, code functionality also outlined.