Skip to content

Cran review fixes 0.7.5 - #4

Open
AleKoure wants to merge 11 commits into
mainfrom
cran-review-fixes-0.7.5
Open

AleKoure wants to merge 11 commits into
mainfrom
cran-review-fixes-0.7.5

Conversation

@AleKoure

Copy link
Copy Markdown
Collaborator

No description provided.

AleKoure and others added 11 commits September 15, 2026 14:37
CRAN review of 0.7.5 asked that package, software and API names be single-quoted in the Title and Description fields, noting that package names are case sensitive.

Quote 'Bootstrap' and use the correctly-cased 'shiny' in both fields. Also rewrite the Description to drop the unsupported comparative claim ('cleaner, more flexible'), keep a consistent declarative mood, and name the actual components instead of 'reusable components'.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
CRAN review of 0.7.5 reported missing \value tags in up to 28 .Rd files and asked that the documentation state the structure/class of the output and what it means.

Add @return to every exported function in R/*.R and regenerate man/. Return classes were verified empirically rather than assumed: UI builders return shiny.tag (some as bslib_fragment), tabItem()/messageItem()/notificationItem()/taskItem() return shiny.tag.list, render* functions return shiny.render.function, and updateBox()/updateCard()/updateTabItems() return NULL invisibly and are documented as called for side effects. Cases returning NULL (disable/empty arguments) are called out explicitly.

Also strengthen the four pre-existing \value tags (dashboardPage, brand_bs_theme, icon, sidebarUserPanel) which named no class. All 31 function .Rd files now have \value; the package-level doc is exempt.

R CMD check --as-cran: 0 errors, 0 warnings.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Follow-up to the CRAN \value work. The first pass was considerably more verbose than the ecosystem norm: median \value length was 119 characters against 65 for 'bslib', the closest analogue (it wraps Bootstrap 5 in the same way).

Rewrite every @return in bslib's register: short noun phrases naming the constructor that produces the object ('A bslib::card() tag, wrapped in a shiny::column() unless width is NULL'), 'Returns a UI element for ... The server value received for the input corresponding to id will be ...' for inputs, and 'nothing. These functions are called for their side-effects.' for side-effecting functions. Link targets were checked to exist before use.

R CMD check --as-cran: 0 errors, 0 warnings.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Replace the notes from the previous round with a point-by-point response to the manual inspection comments of 2026-09-12: software-name quoting, why no method references apply, and the added \value tags.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
24 of the 52 entries were never flagged: British spellings already accepted by the en-GB dictionary implied by Language, and camelCase identifiers the checker does not treat as words. Added 'md', which comes from the CONTRIBUTING.md link text in README. spelling::spell_check_package() is now clean, so a future flag means a real typo.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
https://opensource.org/licenses/MIT now answers 301 and redirects to /license/MIT, which CRAN's URL check reports as 'Moved Permanently'. The redirect target also refuses automated requests with 403, so following it would not help. The repository LICENSE.md is stable and resolves cleanly.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The dashboardSidebar example is charged for the first Sass compile of the session: 2.5s CPU against 6.9s elapsed, dropping to 0.02s CPU once the cache is warm. Also record that pdflatex and pandoc are unavailable locally, so those two checks come from CI.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
win-builder flagged 'dropdown' as possibly misspelled. The hyphenated form is in both the en_GB and en_US dictionaries, so this removes the only avoidable part of the incoming-feasibility NOTE. cran-comments.md now reports the win-builder result, which also shows the earlier example-timing NOTE does not occur on CRAN machines.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.

1 participant