Skip to content

Commit

Permalink
chore: Fix spelling.
Browse files Browse the repository at this point in the history
  • Loading branch information
jakubnowicki committed Feb 23, 2023
1 parent 42b5a7b commit f04e18e
Show file tree
Hide file tree
Showing 17 changed files with 51 additions and 30 deletions.
2 changes: 1 addition & 1 deletion R/logger.R
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#' Helper function to print out log messages into Shiny
#' using cat() and stderr(), as described on
#' using \code{cat()} and \code{stderr()}, as described on
#' https://shiny.rstudio.com/articles/debugging.html
#'
#' Because this can print a lot, it's silent unless
Expand Down
4 changes: 2 additions & 2 deletions R/pages.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ PAGE_404_ROUTE <- "404" #nolint
#'
#' The page which appear when path is wrong.
#'
#' @param page shiny page style, eg. \code{shiny::tags$div(h1("Not found"))}
#' @param page shiny page style, e.g. \code{shiny::tags$div(h1("Not found"))}
#' @param message404 message to display at the 404 website
#'
#' @export
Expand All @@ -33,7 +33,7 @@ page404 <- function(page = NULL, message404 = NULL) {
#' Fix conflicts when some bookmark uses bootstrap
#'
#' This function dynamically removes bootstrap dependency when user opens specified bookmark.
#' It should be inserted in head of bootrstrap page.
#' It should be inserted in head of bootstrap page.
#' @param bookmark Bookmark name on which bootstrap dependency should be suppressed.
#'
#' @importFrom htmltools renderDependencies resolveDependencies
Expand Down
6 changes: 3 additions & 3 deletions R/paths.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ valid_path <- function(routes, path) {
(path %in% names(routes))
}

#' Formats a URL fragment into a hashpath starting with "#!/"
#' Formats a URL fragment into a hash path starting with "#!/"
#'
#' @param hashpath character with hash path
#' @return character with formatted hashpath
#' @return character with formatted hash path
#' @keywords internal
cleanup_hashpath <- function(hashpath) {
hashpath <- hashpath[1]
Expand Down Expand Up @@ -71,7 +71,7 @@ route_link <- function(path) {
#' \item query, a list
#' }
#' @details
#' \code{parse_url_path} allows parsing paramaters lists from url. See more in examples.
#' \code{parse_url_path} allows parsing parameters lists from url. See more in examples.
#'
#' Note that having query string appear before \code{#!} may cause browser to refresh
#' and thus reset Shiny session.
Expand Down
14 changes: 7 additions & 7 deletions R/router.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ ROUTER_UI_ID <- '_router_ui' #nolint

#' Attach 'router-hidden' class to single page UI content
#'
#' @description Covered UI types are Shiny/htmltools tags or tag lists and httml templates.
#' @description Covered UI types are Shiny/htmltools tags or tag lists and html templates.
#' In case of tag list (\code{tagList}) and html template (\code{htmlTemplate}) 'div' wrapper
#' with 'router-hidden' class is added.
#'
#' @param ui Single page UI content created with proper html tags or tag list.
#' @param path Single page path name. Attached to \code{data-path} attriubute.
#' @param path Single page path name. Attached to \code{data-path} attribute.
#' @keywords internal
attach_attribs <- function(ui, path) {
if ("shiny.tag" %in% class(ui)) {
Expand Down Expand Up @@ -187,7 +187,7 @@ create_router_callback <- function(root, routes = NULL) {
#' shiny modules.
#'
#' @details If you are defining the router inside a shiny module,
#' we assume that the namespacing function defined in the UI is named as ns.
#' we assume that the namespacing function defined in the UI is named as \code{ns}.
#'
#' @return Application UI wrapped in a router.
#'
Expand Down Expand Up @@ -261,7 +261,7 @@ router_server_internal <- function(router) {
#' @param router Router pages object. See \link{make_router}.
#'
#' @return list with shiny tags that adds "router-page-wrapper" div and embeds
#' router javascript script.
#' router JavaScript script.
#' @keywords internal
router_ui_internal <- function(router) {
shiny::addResourcePath(
Expand Down Expand Up @@ -343,7 +343,7 @@ get_page <- function(session = shiny::getDefaultReactiveDomain()) {
#'
#' @param page The page to display. Should match one of the paths sent to the
#' @param session Shiny session
#' @param ... Other parameters are sent through to shiny::req()
#' @param ... Other parameters are sent through to \code{shiny::req()}
#' router.
#' @export
is_page <- function(page, session = shiny::getDefaultReactiveDomain(), ...) {
Expand All @@ -354,8 +354,8 @@ is_page <- function(page, session = shiny::getDefaultReactiveDomain(), ...) {
#' Change the currently displayed page.
#'
#' Works by sending a message up to
#' our reactive input binding on the clientside, which tells page.js to update
#' the window URL accordingly, then tells clientside shiny that our reactive
#' our reactive input binding on the client side, which tells page.js to update
#' the window URL accordingly, then tells client side shiny that our reactive
#' input binding has changed, then that comes back down to our router callback
#' function and all other observers watching \code{get_page()} or similar.
#'
Expand Down
2 changes: 0 additions & 2 deletions R/zzz.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
#' On Load
#'
#' On package load it updates .i18_config reading yaml file from config.
#'
#' @param libname library name
#' @param pkgname package name
#'
Expand Down
23 changes: 23 additions & 0 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Appsilon
CMD
RStudio
UI
appsilon
codecov
config
cranlogs
htmltools
http
https
httr
js
minimalistic
namespacing
param
params
repo
rstudio
subpages
ui
webapp
www
4 changes: 2 additions & 2 deletions man/attach_attribs.Rd

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

4 changes: 2 additions & 2 deletions man/change_page.Rd

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

6 changes: 3 additions & 3 deletions man/cleanup_hashpath.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/disable_bootstrap_on_bookmark.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/dot-onAttach.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/is_page.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/log_msg.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/page404.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/parse_url_path.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/router_ui.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/router_ui_internal.Rd

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

0 comments on commit f04e18e

Please sign in to comment.