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

CRAN-ready for 1.0.1 #341

Closed
13 tasks done
lorenzwalthert opened this issue Feb 4, 2018 · 10 comments
Closed
13 tasks done

CRAN-ready for 1.0.1 #341

lorenzwalthert opened this issue Feb 4, 2018 · 10 comments

Comments

@lorenzwalthert
Copy link
Collaborator

lorenzwalthert commented Feb 4, 2018

  • devtools::spell_check()
  • Delete Use @keywords internal for all man files for unexported functions.
  • decide on line break for named arguments (Named arguments and line breaks #318).
  • Get rid of notes.
  • Update NEWS.md. Review PRs messages.
  • Wait for new krlmlr/enc release and adapt DESCRIPTION.
  • Build vignettes locally.
  • update Date: field in DESCRIPTION
  • Bump version to 1.0.1.
  • run CI on fork lorenzwalthert/cranrel to make sure R CMD check reported via tic / rcmdcheck packages is identical to $R CMD check.
  • build with win-build.
  • revdep checking.
  • Update cran-release-notes.md
@krlmlr
Copy link
Member

krlmlr commented Feb 5, 2018

I forgot that you don't need to delete .man files, you can use the @noRd tag instead.

@lorenzwalthert lorenzwalthert mentioned this issue Feb 18, 2018
1 task
@lorenzwalthert
Copy link
Collaborator Author

So should we remove the .Rd of all non-exported functions permanently with @noRd?

@krlmlr
Copy link
Member

krlmlr commented Feb 23, 2018

That sounds like a good idea.

@lorenzwalthert
Copy link
Collaborator Author

lorenzwalthert commented Mar 1, 2018

Not so sure anymore about the @noRdsolution.

  • Exported functions cannot inherit parameters from unexported functions. This triggers a whole chain of problems.
  • Having the full documentation version available during development might be helpful exactly because of that. Using @inheritsParams makes it difficult to see the whole documentation for a function just from the source code. Hence I would prefer to have the rendered .Rd available in some cases.

Can't we just use @keywords internal to generate the documentation but not adding it to the index as suggested in the roxygen vignette?

@lorenzwalthert
Copy link
Collaborator Author

I don't see any indication in the CRAN repository policy that says we can't have internal function documentation rendered to .Rd, so maybe that's worth a try?

@krlmlr
Copy link
Member

krlmlr commented Mar 1, 2018

Sure, we could try @keywords internal.

@lorenzwalthert
Copy link
Collaborator Author

@krlmlr How do we do revdep checking for exampletestr and usethis?

@krlmlr
Copy link
Member

krlmlr commented Mar 2, 2018

Perhaps with the revdepcheck package from r-lib? revdepcheck::revdep_check() should do the job, there are also some functions that summarize the results.

@lorenzwalthert
Copy link
Collaborator Author

Thanks for the hint, just trying that out now.

@lorenzwalthert
Copy link
Collaborator Author

Submitted to CRAN.

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

No branches or pull requests

2 participants