search

keller-mark / pizzarr

Slice into Zarr arrays in R 🍕
https://keller-mark.github.io/pizzarr/
MIT License
25 stars 2 forks source link

Fail in CI if NAMESPACE or Roxygen docs are out of date #54

Open keller-mark opened 10 months ago

keller-mark commented 10 months ago

User story

Even though these are a bit redundant to commit to the repo, I think they are needed for installation from github or from source to work properly.

Preferred solution

Fail in CI if NAMESPACE or Roxygen docs are out of date (e.g., if devtools::document() results in modified files).

Possible alternatives

Add a github actions workflow to automatically commit corrected files back to the main branch

dblodgett-usgs commented 1 month ago

Interesting use case -- do you know of any packages that do this? Mine do not. I rebuild roxygen when I build / install and always check in synced up documentation and namespace.