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

Resolve package check warnings #1

Open
gfinak opened this issue Jan 15, 2020 · 0 comments
Open

Resolve package check warnings #1

gfinak opened this issue Jan 15, 2020 · 0 comments

Comments

@gfinak
Copy link
Member

gfinak commented Jan 15, 2020

While I'm aware we're still in early development, the state of the package docs make it next to impossible to collaborate.
I've done a bit of work to clean it up, but there are still many issues visible via R CMD check.

  • Undocumented code objects.
    • since we're using S3, do the S3 object specific methods even need to be exported? Can we just export the default methods and have those dispatch correctly?
  • Undocumented parameters
    • signatures differ between many default methods and their object specific methods.
      • We need to make sure all of the parameters are documented correctly and unambiguously, and the appropriate usage sections are in place.
  • No object documentation for S3 objects.
    how do the pieces fit together?

Addressing these now and keeping the docs up to date will save time and trouble later.

gfinak pushed a commit that referenced this issue Jan 15, 2020
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

No branches or pull requests

1 participant