Roxygen #780
Merged
Roxygen #780
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…or data documentation.
olivroy
commented
Sep 19, 2023
|
Excellent, thx! There is one small merging conflict. Which one shall we use @olivroy ? |
|
@mtennekes Merged conflict + added myself as ctb while I was at it. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #778. Part of #776
(the last commit didn't want to show up on the PR)
Imo, this simplifies the documentation by using markdown. Adding () to signify a function, to make it distinct from arguments.
roxygen2md::roxygen2md() + tweaks
Remove broken links
Simplify documentation for data https://r-pkgs.org/data.html#sec-documenting-data
A round of doc improvement could probably be done prior to release.
as an example, see how on the tmap website, the group argument doc is not rendered correctly, without Roxygen(markdown = TRUE)