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

Spellcheck, fix docs for R CMD check, rebuild pkgdown #63

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

alistaire47
Copy link

Hi! Saw a typo on the pkgdown, figured I'd make a quick PR, and things escalated to a bit more housekeeping-type stuff. I see there are some similar PRs already, but they're years old and would need a messy rebase and update, so I figured it's easier just to start from scratch. If this PR gets to be that old, feel free to decline it.

What this does:

  1. Spellchecked docs
  2. Tweaked docs where necessary to make R CMD check pass
    a. One notable change here is deprecating the smart param of ipsum(), because it gets passed to rmarkdown::html_document_base() which is ignoring it. Can handle this differently if you like, but it had to be documented somehow for R CMD check to pass.
  3. Rebuilt pkgdown site to capture all the updates to docs
    a. I did add a truly minimal _pkgdown.yml with the URL linked from this repo (https://cinc.rud.is/web/packages/hrbrthemes/), though it looks like it's also hosted on gh pages (https://hrbrmstr.github.io/hrbrthemes/). That file can be reverted or changed if desired.

@@ -90,7 +91,6 @@ ipsum <- function(number_sections = FALSE,
clean_supporting = self_contained,
pre_processor = pre_processor,
base_format = rmarkdown::html_document_base(
smart = smart,
Copy link
Author

Choose a reason for hiding this comment

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

This is the one code change. Since this is getting passed through to ... and ignored, it should not affect behavior.

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

1 participant