From ac341de1e82406cfe54b9a004d5cbf87325ff5f9 Mon Sep 17 00:00:00 2001 From: Kamil Zyla Date: Wed, 7 Sep 2022 14:27:22 +0200 Subject: [PATCH] chore: Upgrade roxygen2 to 7.2.1 and regenerate documentation --- DESCRIPTION | 4 ++-- man/build_js.Rd | 16 ++++++++++++---- man/lint_js.Rd | 4 +++- 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 85285b9e..0862ade5 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: rhino Title: A Framework for Enterprise Shiny Applications -Version: 1.1.0 +Version: 1.1.1 Authors@R: c( person("Kamil", "Zyla", role = c("aut", "cre"), email = "kamil@appsilon.com"), @@ -15,7 +15,7 @@ BugReports: https://github.com/Appsilon/rhino/issues License: LGPL-3 Encoding: UTF-8 Roxygen: list(markdown = TRUE) -RoxygenNote: 7.1.2 +RoxygenNote: 7.2.1 Depends: R (>= 2.10) Imports: diff --git a/man/build_js.Rd b/man/build_js.Rd index c52feda2..995502f3 100644 --- a/man/build_js.Rd +++ b/man/build_js.Rd @@ -22,16 +22,24 @@ Requires Node.js and the \code{yarn} command to be available on the system. } \details{ Functions/objects defined in the global scope do not automatically become \code{window} properties, -so the following JS code:\if{html}{\out{
}}\preformatted{function sayHello() \{ alert('Hello!'); \} +so the following JS code: + +\if{html}{\out{
}}\preformatted{function sayHello() \{ alert('Hello!'); \} }\if{html}{\out{
}} -won't work as expected if used in R like this:\if{html}{\out{
}}\preformatted{tags$button("Hello!", onclick = 'sayHello()'); +won't work as expected if used in R like this: + +\if{html}{\out{
}}\preformatted{tags$button("Hello!", onclick = 'sayHello()'); }\if{html}{\out{
}} -Instead you should explicitly export functions:\if{html}{\out{
}}\preformatted{export function sayHello() \{ alert('Hello!'); \} +Instead you should explicitly export functions: + +\if{html}{\out{
}}\preformatted{export function sayHello() \{ alert('Hello!'); \} }\if{html}{\out{
}} -and access them via the global \code{App} object:\if{html}{\out{
}}\preformatted{tags$button("Hello!", onclick = "App.sayHello()") +and access them via the global \code{App} object: + +\if{html}{\out{
}}\preformatted{tags$button("Hello!", onclick = "App.sayHello()") }\if{html}{\out{
}} } \examples{ diff --git a/man/lint_js.Rd b/man/lint_js.Rd index 320f2394..83af8679 100644 --- a/man/lint_js.Rd +++ b/man/lint_js.Rd @@ -25,7 +25,9 @@ To access it without raising linter errors, add \verb{/* global L */} comment in You don't need to define \code{Shiny} and \code{$} as these global variables are defined by default. If you find a particular ESLint error inapplicable to your code, -you can disable a specific rule for the next line of code with a comment like:\if{html}{\out{
}}\preformatted{// eslint-disable-next-line no-restricted-syntax +you can disable a specific rule for the next line of code with a comment like: + +\if{html}{\out{
}}\preformatted{// eslint-disable-next-line no-restricted-syntax }\if{html}{\out{
}} See the \href{https://eslint.org/docs/user-guide/configuring/rules#using-configuration-comments-1}{ESLint documentation}