Skip to content

docs: fix some typos#625

Open
jeis4wpi wants to merge 3 commits into
grantmcdermott:mainfrom
jeis4wpi:main
Open

docs: fix some typos#625
jeis4wpi wants to merge 3 commits into
grantmcdermott:mainfrom
jeis4wpi:main

Conversation

@jeis4wpi

Copy link
Copy Markdown

docs: fix some typos

Is this helpful?

Signed-off-by: John E <jeis4wpi@outlook.com>
@grantmcdermott

Copy link
Copy Markdown
Owner

Thanks, this is great. (Plus we can point to this as proof that our docs weren't AI-written...)

Two things:

  • The test suite is failing b/c we need to regenerate the "restore_par_TRUE" snapshot (in inst/tinytest/test-restore_par.R).
  • We also need to update the .Rd files. Either run make document from your terminal, or devtools::document() from your R console.

I'm happy to fix both if you're unsure.

@jeis4wpi

Copy link
Copy Markdown
Author

so make this change:

-expect_snapshot_plot(f2, label = "restore_par_FALSE")
+expect_snapshot_plot(f2, label = "restore_par_TRUE")

and create the updated docs? I think I can do this?

@jeis4wpi

Copy link
Copy Markdown
Author
> devtools::document()
ℹ Updating tinyplot documentation
ℹ Loading tinyplot
✖ type_ridge.R:673: S3 method `quantile.density` needs @export or @exportS3Method tag.
Writing tpar.Rd
Writing type_abline.Rd
Writing type_ridge.Rd
Writing type_text.Rd
>

Signed-off-by: John E <jeis4wpi@outlook.com>
@grantmcdermott

Copy link
Copy Markdown
Owner

so make this change(?)

Not quite. What you need to do is:

  1. Delete the existing SVG snapshot (which still has the typo in it) here: inst/tinytest/_tinysnapshot/restore_par_TRUE.svg.

  2. Regenerate the (new) snapshot. This is the trickier part b/c it must be done on Linux for annoying font reasons. You have two options:

    1. If you're on Linux already, make sure you have the Suggests dependencies (tinysnapshot, etc.) Then just run from your R console: pkgload::load_all(); tinytest::run_test_file("inst/tinytest/test-test-restore_par.R")
    2. If you're not on Linux, you can use our bundled .devcontainer setup. Open up your local clone of this repo in VS Code (or alike IDE) and then, from the command palette, choose "Reopen folder in DevContainer". This will take a minute or three for the Docker image to build. Once it's done, simply open a terminal (Ctrl+j/Cmd+j) and run make testall.

Let me if 2 sounds like a pain, or you have any trouble. I'm happy to regenerate the snapshot myself.

@jeis4wpi

Copy link
Copy Markdown
Author

Hi Grant,

I am working on MAC OSX. I could try say Ubuntu container or from the .devtools?

fatal error: 'Magick++.h' file not found

is my current stuck point even though:

homebrew % find . -name Magick++.h
./Cellar/graphicsmagick/1.3.47/include/GraphicsMagick/Magick++.h
./Cellar/imagemagick/7.1.2-25/include/ImageMagick-7/Magick++.h

Looks like it will take me some time before I have a working development environment.

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