fixed typos in R package docs #4345
Conversation
|
I see that my build is failing with this error:
This is an error I saw a lot in my own projects (private and open source) when devtools went to 2.0.0. This is a result of the use of Do you have an issue open to replace it? I would love to contribute a fix! |
|
@jameslamb That would be great! There's no open issue yet, but feel free to open a new pull request |
|
@jameslamb Thanks, please go ahead and submit a PR. ;-) |
|
I've rebased this to |
|
I think Travis is failing because of that same transient failure in the |
Codecov Report
@@ Coverage Diff @@
## master #4345 +/- ##
=========================================
- Coverage 67.93% 67.83% -0.1%
=========================================
Files 132 132
Lines 12239 12206 -33
=========================================
- Hits 8314 8280 -34
- Misses 3925 3926 +1
Continue to review full report at Codecov.
|
R-package/man/xgb.train.Rd
Outdated
| @@ -210,7 +211,7 @@ dtest <- xgb.DMatrix(agaricus.test$data, label = agaricus.test$label) | |||
| watchlist <- list(train = dtrain, eval = dtest) | |||
|
|
|||
| ## A simple xgb.train example: | |||
| param <- list(max_depth = 2, eta = 1, verbosity = 0, nthread = 2, | |||
| param <- list(max_depth = 2, eta = 1, silent = 1, nthread = 2, | |||
There was a problem hiding this comment.
The silent parameter is deprecated, see https://xgboost.readthedocs.io/en/latest/parameter.html .
There was a problem hiding this comment.
@trivialfis oh this is interesting. I didn't actually touch this line directly. File changes in .Rd files were auto-generated when I ran devtools::document().
Maybe I should rebase and try again?
There was a problem hiding this comment.
ohhhhh I wonder if someone in a previous PR manually edited the .Rd but not the corresponding roxygen block in the R code? I'll fix that on this PR
There was a problem hiding this comment.
Ok yes, this is what happened! I walked through the blame and found that this parameter was changed in xgb.train.Rd in #4267 but not the corresponding roxygen content in the R source code.
There was a problem hiding this comment.
@jameslamb Thanks for fixing my mistake! I restarted the test and will merge once they are done.
There was a problem hiding this comment.
No problem, happy to help!
|
Thanks! |
* fixed typos in R package docs * updated verbosity parameter in xgb.train docs
Thank you for this great project. I hope you'll consider this pull request to fix minor typos in the R-package documentation (found with
devtools::spell_check()).I apologize about the extra lines touched for trailing whitespace, that is a setting I have in my IDE. Please let me know if you would like me to revert those whitespace-only edits.
I also regenerated the documentation with
devtools:;document()so the.Rdfiles inman/would be consistent with the roxygen changes I made.