LoginSign Up
← Back to all sparks
R

roclang

ANALYTICS
Velocity0.0

R package roclang by zhuxr11 — release notes from GitHub.

github.com/zhuxr11/roclang ↗

A roxygen2 documentation-reuse helper whose release notes are mostly upstream damage control.

roxygen2documentationdeveloper-toolingupstream-compatr-package
◆Current state
roclang lets package authors pull documentation text out of an existing function's roxygen block and splice it into their own — extract_roc_text() with type = "param", "dot_params" or a section selector. The feature surface has been stable since 0.2.1; the parameter-matching rules and the checks for invalid or ambiguous extractions are the substance of what shipped.
◆Where it's heading
Nearly every release since 0.2.0 has been reactive. The package parses documentation text produced by other packages, so a wording change in stats::lm()'s documentation breaks its test suite, and a roxygen2 selection-semantics change forces its parameter matching to follow. The 0.2.3 release is exactly this pattern again. Release cadence has slowed to roughly one entry every two years, and the last two carried no functional change at all.
◆Prediction
Further releases are most likely triggered by upstream roxygen2 or base R documentation edits breaking tests rather than by new extraction capability. The entries show no queued feature work.

◆Recent moves

  1. 11mo ago

    Test fix for changed stats::lm() Reference section

    A test fix after the Reference section of stats::lm()'s documentation changed. The characteristic roclang release — the package reads other packages' doc text, so their edits break its fixtures.

    View source ↗
  2. 3y ago

    README loading switched to pkgload, downloads badge added

    Switches README package loading to pkgload and adds a downloads badge. Repository presentation only; no change to the extraction functions.

    View source ↗
  3. 3y ago

    Dot-params error messages and ... selection unblocked

    Negative selection of non-matched parameters under type = "dot_params" now produces meaningful errors, and the restriction on selecting ... under type = "param" is lifted. Both sharpen the parameter-matching rules that are the package's actual interface.

    View source ↗
  4. 4y ago

    Multi-parameter selection follows roxygen2 7.1.2 semantics

    Follows roxygen2 > 7.1.2's rule that co-documented parameters are selected as a whole set, while keeping backward compatibility with 7.1.2 and earlier. Extractions returning NA_character_ or multiple entries now error rather than passing silently.

    View source ↗
  5. 4y ago

    Ambiguous unqualified function names now error

    An unqualified function name that resolves in more than one package — filter in both dplyr and stats — now errors instead of silently picking one. A real ambiguity guard for a package whose whole job is resolving function references.

    View source ↗
  6. 4y ago

    CI workflows, fuller test coverage, unqualified-package fix

    Adds R CMD check and coverage workflows with badges, expands tests, and fixes citing a parameter from an attached but unqualified package. Note this entry is stamped fifty seconds after 0.1.3 despite the lower version — tag order on this feed does not track release order.

    View source ↗