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

Doco #81

Merged
merged 4 commits into from
May 21, 2024
Merged

Doco #81

merged 4 commits into from
May 21, 2024

Conversation

dblodgett-usgs
Copy link
Collaborator

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
Copy link
Collaborator Author

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
Copy link
Collaborator Author

image

@dblodgett-usgs
Copy link
Collaborator Author

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?

Copy link
Owner

@keller-mark keller-mark left a comment

Choose a reason for hiding this comment

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

Thanks! Looks good, will merge now. I did not know about the @inheritParams or the intended usage of @field

@keller-mark keller-mark merged commit 572ff32 into keller-mark:main May 21, 2024
1 of 2 checks passed
@dblodgett-usgs
Copy link
Collaborator Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants