[docs][R-package] update docs on C++ interface #4257
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
StrikerRUS
requested changes
May 6, 2021
Co-authored-by: Nikita Titov <[email protected]>
Co-authored-by: Nikita Titov <[email protected]>
StrikerRUS
approved these changes
May 6, 2021
StrikerRUS
changed the title
|
This pull request has been automatically locked since there has not been any recent activity since it was closed. To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues including a reference to this. |
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.
There have been several changes to the R package's C++ interface recently, in works towards #3016.
As a result of those changes (and other changes before), the documentation comments in
R-package/src/lightgbm_R.hcontain some inconsistencies, typos, and other small issues. For example, as of #4244 most of the functions there return an R NULL value, but their docs still say they return an integer indicating whether they succeeded or failed.This PR proposes fixing them.
Notes for Reviewers
I intentionally skipped the four functions modified in #4256, since that PR changes those functions' signatures and docs.