ropensci / BaseSet

Provides classes for working with sets
https://docs.ropensci.org/BaseSet
Other
10 stars 3 forks source link

pkgdown error #66

Closed maelle closed 1 year ago

maelle commented 1 year ago

Via https://ropensci.r-universe.dev/builds

! All topics must be included in reference index
✖ Missing topics: dimnames.TidySet, names.TidySet
ℹ Either add to _pkgdown.yml or use @keywords internal

You can use pkgdown::check_pkgdown() to check the config file without building the site.

llrs commented 1 year ago

Thanks, I didn't notice yesterday. I always forget to check before pushing to check this as in most packages I don't have to manually set them. I was just working on a git hook using check_pkgdown before pushing to prevent those kind of errors. Will fix soon

maelle commented 1 year ago

Interesting idea to use a git hook! (I had seen GHA workflows)

llrs commented 1 year ago

Yes, pretty minimal and easy https://github.com/llrs/rutils/blob/master/inst/pre-push in repo/.git/hooks (with execution permission). I'm working to automate some steps/config I usually do (or rare things that are hard to setup).

maelle commented 1 year ago

do you use the precommit R package or "just" Git?

llrs commented 1 year ago

Just git. There is an issue with the python pre-commit dependency of the package inside Rstudio https://github.com/rstudio/rstudio/issues/6471 that lead me to this.

llrs commented 1 year ago

The webpage should be fixed now (but I have in place a failing test to remind me where to continue working).

It seems that the hooks must be in place before the Rstudio opens (restarting the project doesn't work), and I end up doing it from the terminal.

maelle commented 1 year ago

Thank you!!