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

[R-package] [docs] upgrade docs to roxygen2==7.2.0 #5251

Merged
merged 2 commits into from
Jun 5, 2022

Conversation

jameslamb
Copy link
Collaborator

@jameslamb jameslamb commented May 29, 2022

Contributes to #3763.

{roxygen2} v 7.2.0 was released 16 days ago (https://cran.r-project.org/web/packages/roxygen2/index.html). This project currently uses v7.1.2.

This PR proposes updating the R package's documentation to use the newest version of {roxygen2}.

I regenerated the R package's documentation by running the following.

# install latest roxygen2 locally
Rscript -e "install.packages('roxygen2', repos = 'https://cran.r-project.org')"

# rebuild docs
sh build-cran-package.sh --no-build-vignettes
R CMD INSTALL --with-keep.source ./lightgbm_3.3.2.tar.gz
cd R-package/
Rscript -e "roxygen2::roxygenize(load = 'installed')"

Notes for Reviewers

I didn't see this item listed in #3763, so I edited the description there today to include it.

@StrikerRUS could you temporarily enable readthedocs builds for this branch so we can check that this change will work there?

@jameslamb jameslamb added the doc label May 29, 2022
@jameslamb jameslamb changed the title [R-package] upgrade docs to roxygen2==7.2.0 [R-package] [docs] upgrade docs to roxygen2==7.2.0 May 29, 2022
Copy link
Collaborator

@StrikerRUS StrikerRUS left a comment

Choose a reason for hiding this comment

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

@jameslamb
Copy link
Collaborator Author

excellent, thanks @StrikerRUS !

@jameslamb jameslamb merged commit 1cc9f9d into master Jun 5, 2022
@jameslamb jameslamb deleted the docs/roxygen2-version branch June 5, 2022 04:42
@jameslamb jameslamb mentioned this pull request Oct 7, 2022
40 tasks
@github-actions
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants