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

Roxygen #780

Merged
merged 9 commits into from
Sep 20, 2023
Merged

Roxygen #780

merged 9 commits into from
Sep 20, 2023

Conversation

olivroy
Copy link
Contributor

@olivroy olivroy commented Sep 19, 2023

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)

README.md Show resolved Hide resolved
@mtennekes
Copy link
Member

Excellent, thx! There is one small merging conflict. Which one shall we use @olivroy ?

@mtennekes
Copy link
Member

Oh, and when you are still working on DESCRIPTION @olivroy , please don't forget to put your name on the @authors@R list :-) (fully deserved)

@olivroy
Copy link
Contributor Author

olivroy commented Sep 20, 2023

@mtennekes Merged conflict + added myself as ctb while I was at it.

Thanks!

@mtennekes mtennekes merged commit 2ab6b65 into r-tmap:master Sep 20, 2023
4 of 5 checks passed
@olivroy olivroy deleted the roxygen branch September 20, 2023 11:40
@olivroy olivroy mentioned this pull request Sep 21, 2023
5 tasks
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