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

add items for help pages #11

Merged
merged 9 commits into from
Nov 1, 2024
Merged

add items for help pages #11

merged 9 commits into from
Nov 1, 2024

Conversation

hturner
Copy link
Owner

@hturner hturner commented Sep 26, 2024

Considered but not included:

  • inlinedocs - seems only to be used by one of author's own packages, superseded/out-competed by roxygen2.
  • gbRd - mainly a workhorse package for Rdpack, already mentioned.
  • katex - has math_md() function for embedding math in R documentation; can't see this is any different from what R does since R 4.2.0. Similarly mathjaxr may now be superseded by improved KaTeX/MathJax handling in Rd files. katex may be worth mentioning in the vignette section for creating HTML vignettes where math continues to display offline (need to test).

@hturner hturner linked an issue Sep 26, 2024 that may be closed by this pull request
@hturner hturner requested a review from llrs September 26, 2024 18:42
Copy link
Collaborator

@llrs llrs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch about tools::checkRd! It looks great with lots of useful packages.

I am not sure if in text roxygen2 comments should be that or just roxygen comments (I started converting the later to the first but stopped as I saw it was consistent). The first matches the package name which will help people new to it, the second one is easier to read but might confuse readers.

proposal.md Outdated Show resolved Hide resolved
proposal.md Show resolved Hide resolved
@llrs
Copy link
Collaborator

llrs commented Sep 28, 2024

About the katex and mathjaxr, if they are no longer recommended it does not make sense but katex might still have some uses.

@llrs llrs mentioned this pull request Sep 28, 2024
@hturner
Copy link
Owner Author

hturner commented Oct 1, 2024

About the katex and mathjaxr, if they are no longer recommended it does not make sense but katex might still have some uses.

I think katex was mainly a package that filled a gap while base R and other packages caught up. E.g. here is Christophe Dervieux discussing it in the context of rmarkdown/bookdown: rstudio/bookdown#401 (comment). So I think we can leave it out and reconsider if someone makes a case for it.

@hturner
Copy link
Owner Author

hturner commented Oct 1, 2024

Discovered CRAN package {Rd2md} by looking at {ropenscilabs/r2readthedocs}

Copy link
Collaborator

@llrs llrs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, I would merge it as is. Thanks!

@hturner hturner merged commit 68e7384 into main Nov 1, 2024
@hturner hturner deleted the 10-add-items-for-help-pages branch November 1, 2024 15:09
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.

Add items for help pages
2 participants