search

keller-mark / pizzarr

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

Doco #81

Closed dblodgett-usgs closed 4 months ago

dblodgett-usgs commented 4 months ago

Working through the package cleaning up documentation warnings printed by roxygen -- mostly just adding TODOs but did a little actual contribution in here.

(sorry for the false start -- realizing you squashed that last PR and wanted to clean up the history)

dblodgett-usgs commented 4 months ago

I'm working through the rest of the roxygen warnings -- I'm seeing the @field annotation on a lot of private fields -- looks like the @field documentation only goes on public fields? Just want to make sure you are aware I'm removing those.

dblodgett-usgs commented 4 months ago

image

dblodgett-usgs commented 4 months ago

Alright @keller-mark -- my local build round tripping roxygen2 is quiet now. I stupped in a lot of documentation with TODOs but did fill in quite a few with reasonably useful content. As I work on things going forward, I'll do my best to work on all these TODOs. Anything you would like me to change here before merging in?

dblodgett-usgs commented 4 months ago

Awesome! I kind of want to go look at some of the ropensci packages for how they are using roxygen under R6. It's hard to reuse documentation without more direct inheretence -- which just isn't really built in at this point from what I see.