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

fix: render other md log formats("gfm", "commonmark", "markua") #101

Merged
merged 2 commits into from
Oct 7, 2024

Conversation

Lovemore-Gakava
Copy link
Collaborator

@Lovemore-Gakava Lovemore-Gakava commented Oct 4, 2024

Updates

  • updated location of temporary files for md
  • updated name of log to end in <filename>_log_<md type>.md
  • used options for create_outputs format argument

Steps

library(whirl)
options(whirl.out_formats = c("html", "gfm", "commonmark", "markua"))
options::opt("out_formats", env = "whirl")
result <- run("inst/examples/simple/prg1.R")

Expected files output at the same location as code
image

Follow-up - potential tickets/issues

  1. Do we want to track this files in the summary html? and/or
  2. Do we need different formats for the summary?

- updated location of temporary files for md
- updated name of log to end in <filename>_log_<md type>.md
- used options for create_outputs format argument
@Lovemore-Gakava Lovemore-Gakava linked an issue Oct 4, 2024 that may be closed by this pull request
@Lovemore-Gakava Lovemore-Gakava marked this pull request as ready for review October 4, 2024 10:46
@akselthomsen akselthomsen self-requested a review October 7, 2024 16:34
Signed-off-by: Aksel Thomsen <[email protected]>
Copy link

github-actions bot commented Oct 7, 2024

Github pages

Review the pkgdown webpage for the PR here

Copy link

github-actions bot commented Oct 7, 2024

Code coverage

Name Coverage (%)
whirl 59.88
R/approvedpkgs.R 0.00
R/custom_logging.R 63.04
R/enrich_input.R 100.00
R/internal_run.R 100.00
R/mdformats.R 0.00
R/normalize_with_base.R 100.00
R/pb_script.R 43.75
R/quarto.R 95.24
R/read_regexp.R 93.33
R/render_summary.R 94.12
R/renv.R 0.00
R/run.R 100.00
R/session.R 79.86
R/status.R 91.30
R/strace.R 0.00
R/util_queue_summary.R 100.00
R/whirl_queue.R 94.12
R/whirl_r_session.R 82.11
R/zzz.R 0.00

@akselthomsen
Copy link
Contributor

akselthomsen commented Oct 7, 2024

I just tried the branch - and it works good :)
For the two questions:

  1. We don't track the html log today, so I don't think we need to add them
  2. I am in doubt. In a way it would be nice, but not sure they will be useful. But should probably be controlled in the argument to run() anyway, and not through an option.

P.S. I just bumped the version.

@Lovemore-Gakava Lovemore-Gakava merged commit 8022590 into main Oct 7, 2024
13 of 14 checks passed
@Lovemore-Gakava Lovemore-Gakava deleted the 100-fix-ensure-md-formats-can-be-generated branch October 7, 2024 17: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.

fix: ensure md formats can be generated
2 participants