Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: tinyrox
Title: Minimal R Documentation Generator
Version: 0.3.3.5
Version: 0.3.3.6
Authors@R:
person("Troy", "Hernandez", email = "troy@cornball.ai", role = c("aut", "cre"),
comment = c(ORCID = "0009-0005-4248-604X"))
Expand Down
2 changes: 0 additions & 2 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

export(check_code_cran)
export(check_cran)
export(check_description_cran)
export(check_examples_cran)
export(clean)
export(document)
export(fix_description_cran)
export(parse_tags)
6 changes: 6 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# tinyrox 0.3.3.6

* Accept `@returns` as a plural alias of `@return` (#24). roxygen2 supports both spellings, so an unlisted `@returns` no longer aborts `document()`.
* Unknown tags now warn and are skipped instead of aborting the run (roxygen2's behavior). One unlisted or misspelled tag no longer takes down `document()` for the whole package; the offending tag is named in the warning and its content is dropped, while every other tag still parses.
* Remove DESCRIPTION-field linting (#23). The Title/Description unquoted-name check (`check_description_cran()`, `fix_description_cran()`) and the web-service-link check are gone. A documentation generator should not lint DESCRIPTION prose; the checks leaned on hardcoded, opinionated name lists with no roxygen2 or `R CMD check` equivalent, and one of them flagged (and `fix = TRUE` would rewrite) the ordinary word "graphics" in "base R graphics system". The token-based code checker and example checks (`check_cran()`, `check_examples_cran()`) remain.

# tinyrox 0.3.3.5

* The CRAN code checker scans parse tokens (`utils::getParseData()`) instead of raw source lines (#20). Comments and string literals can no longer trigger findings, `torch.cat()` is no longer `cat()`, `print()`/`cat()` are allowed inside `print.*`/`format.*` S3 methods, and a local variable named `T` or `F` is no longer mistaken for the logical shorthand. `setwd()`/`on.exit()` pairing and `set.seed()` literals are judged within the enclosing function instead of a fixed line window. Unparseable files report one finding instead of erroring.
Expand Down
1 change: 0 additions & 1 deletion R/check_code.R
Original file line number Diff line number Diff line change
Expand Up @@ -304,4 +304,3 @@ call_expr_text <- function(pd, id, parents) {
text <- tryCatch(utils::getParseText(pd, call_expr), error = function(e) "")
paste(text, collapse = "\n")
}

Loading
Loading