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

Improve documentation #2285

Merged
merged 11 commits into from Dec 10, 2023
Merged

Improve documentation #2285

merged 11 commits into from Dec 10, 2023

Conversation

olivroy
Copy link
Contributor

@olivroy olivroy commented Dec 8, 2023

  • Take advantage of roxygen markdown support
  • Update links
  • Generate package docs with roxygen2.
  • Add @keywords internal, so that the functions that are not user-facing do not appear in the function index on the pkgdown site (nor in R help system), but still exported. copy from roxygen2 docs: There’s one exception: @keywords internal. It’s useful because it removes the function from the documentation index; it’s useful for functions aimed primarily at other developers, not typical users of the package.
  • Fixup the defunct docs
  • Have ?sf point to st_sf() rather than the package docs.
  • Fixup aliases: they should be separated by spaces, not commas (there still may be some problems of duplicate aliases?)
  • Update @name vs @rdname Reference roxygen2 (generally, @name should be used to override the default name of the man page, and @rdame should be used to document other things in the same man page.

I recommend you look primarly at the diff of Rd files, as it will be more telling of the impacts of the changes.

@edzer edzer merged commit d7f19fd into r-spatial:main Dec 10, 2023
7 checks passed
@edzer
Copy link
Member

edzer commented Dec 10, 2023

Great clean-up, thanks!

@olivroy olivroy deleted the roxygen branch December 11, 2023 12:55
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.

None yet

2 participants