Skip to content
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

[docs] R docs cleanup #2375

Merged
merged 2 commits into from
Sep 5, 2019
Merged

[docs] R docs cleanup #2375

merged 2 commits into from
Sep 5, 2019

Conversation

StrikerRUS
Copy link
Collaborator

@StrikerRUS StrikerRUS commented Sep 3, 2019

Result: https://lightgbm.readthedocs.io/en/r_examples/R/reference/index.html

  • Fixed duplicated output from examples.

Before:

image

After:

image

  • Unified rendering of lgb.Dataset and lgb.Booster names.

@StrikerRUS
Copy link
Collaborator Author

Unfortunately, I have no R installed on my machine, so someone should update https://github.com/microsoft/LightGBM/tree/master/R-package/man folder before merging this PR.

@jameslamb
Copy link
Collaborator

I can regenerate the man/ folder right now

Copy link
Collaborator

@jameslamb jameslamb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! @StrikerRUS I added bd75d6f to update the man/ folder. A few other small things in there that seem unrelated to your changes, seems they were not regenerated in past PRs.

@@ -646,7 +646,7 @@ Dataset <- R6::R6Class(
#' @param colnames names of columns
#' @param categorical_feature categorical features
#' @param free_raw_data TRUE for need to free raw data after construct
#' @param info a list of information of the lgb.Dataset object
#' @param info a list of information of the \code{lgb.Dataset} object
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good change, thank you

@StrikerRUS
Copy link
Collaborator Author

@jameslamb Thank you very much!

A few other small things in there that seem unrelated to your changes, seems they were not regenerated in past PRs.

Yeah, changes from #2176 were not regenerated.

@StrikerRUS StrikerRUS merged commit 4c8418e into master Sep 5, 2019
@StrikerRUS StrikerRUS deleted the r_examples branch September 5, 2019 12:51
@lock lock bot locked as resolved and limited conversation to collaborators Mar 10, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants