Skip to content

Commit

Permalink
Fix package documentation help page
Browse files Browse the repository at this point in the history
  • Loading branch information
Kiernan Nicholls committed Oct 6, 2023
1 parent f8df254 commit 060c9b5
Show file tree
Hide file tree
Showing 7 changed files with 77 additions and 13 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: gluedown
Title: Wrap Vectors in Markdown Formatting
Version: 1.0.6.9000
Version: 1.0.7
Authors@R:
person(given = "Kiernan",
family = "Nicholls",
Expand Down Expand Up @@ -40,4 +40,4 @@ VignetteBuilder:
Encoding: UTF-8
Language: en-US
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.1.1
RoxygenNote: 7.2.3
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# gluedown (development version)
# gluedown 1.0.7

# gluedown 1.0.6

Expand Down
26 changes: 26 additions & 0 deletions R/gluedown-package.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#' @title gluedown: A package to format character vectors with markdown.
#'
#' @description The `gluedown` package helps transition from R's powerful
#' vectors to formatted markdown text. The functions use [glue::glue()] to
#' wrap character vectors in valid markdown syntax. In combination with the
#' `knitr` package, this allows users to directly print R vectors as formatted
#' text for improved clarity and readability.
#'
#' @section Glue wrappers:
#' The `md_*()` functions return `glue` objects, which are returned using
#' [cat()] by default. This allows users to both manipulate the formatted
#' strings as they would with any character vector and still present the
#' string to the user when an `knitr` chunk option is set to return code
#' results `'asis'`.
#'
#' @section Other wrappers:
#' The [md_table()] and [md_convert()] functions wrap around [knitr::kable()]
#' and [markdown::markdownToHTML()] respectively. The later allows users to
#' convert `md_*()` outputs to HTML fragments.
#'
#' @keywords internal
"_PACKAGE"

## usethis namespace: start
## usethis namespace: end
NULL
10 changes: 2 additions & 8 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,6 @@

## Resubmission

* 2022-11-05: Update redirected URL
* Bump to version 1.0.6
### 2023-10-06

<!-- links: start -->
[gh_act]: https://github.com/kiernann/gluedown/actions
[rhub_win]: https://builder.r-hub.io/status/gluedown_1.0.4.tar.gz-d803fb486c644b2fbcb7d62ca5b1d405
[rhub_ubu]: https://builder.r-hub.io/status/gluedown_1.0.4.tar.gz-17912d7e2d5f46098b4ebf2755096ffd
[rhub_fed]: https://builder.r-hub.io/status/gluedown_1.0.4.tar.gz-0d4589b34c1648e58a641fcb1c1044e4
<!-- links: end -->
* Fix package documentation page.
44 changes: 44 additions & 0 deletions man/gluedown-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/gluedown.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/md_convert.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 060c9b5

Please sign in to comment.