Skip to content

CRAN pre-submission cleanup - #16

Closed
TroyHernandez wants to merge 4 commits into
mainfrom
cran-presubmission
Closed

CRAN pre-submission cleanup#16
TroyHernandez wants to merge 4 commits into
mainfrom
cran-presubmission

Conversation

@TroyHernandez

Copy link
Copy Markdown
Contributor

Pre-submission review pass (CRAN cookbook walk + probes). Findings fixed:

DESCRIPTION

  • Single-quote software names: 'FFmpeg' (Title + Description), 'OpenTimelineIO', 'rotio'.
  • Add reference URLs: FFmpeg https://ffmpeg.org/, OpenTimelineIO https://opentimeline.io/.
  • Add URL and BugReports (now-public GitHub repo).

Docs

  • Add @examples to exported align_overlaps().
  • Add @param/@return to internal rms helpers (.rms_filter, .parse_rms).

Deliberately unchanged

  • Examples stay \dontrun: they need the ffmpeg binary (a SystemRequirement, not guaranteed on CRAN hosts) plus user-supplied media files, the canonical \dontrun case, not \donttest.

Checks (all --as-cran, 1 NOTE = 'New submission' only, 0 errors/warnings)

  • Local Linux: clean
  • windows-hr R 4.6.0: clean
  • windows-hr R-devel: clean

Version bump 0.1.0.7 -> 0.1.0.8.

DESCRIPTION: single-quote 'FFmpeg' / 'OpenTimelineIO' / 'rotio' in Title
and Description, add reference URLs for FFmpeg and OpenTimelineIO, and add
URL/BugReports pointing at the GitHub repo. Add an @examples block to the
exported align_overlaps(), and @param/@return to the internal rms helpers.
Examples stay \dontrun: they need the ffmpeg binary (a SystemRequirement,
not guaranteed on CRAN check hosts) plus user-supplied media files.
@TroyHernandez

Copy link
Copy Markdown
Contributor Author

Superseded. Every change in this PR is already on main: the quoted software names and reference URLs plus URL/BugReports in DESCRIPTION, cran-comments.md, the align_overlaps() example, the @param/@return blocks on the rms helpers, and the pull_request-only CI trigger. A reverse diff (git diff cran-presubmission main) shows main strictly ahead with nothing missing. Closing rather than merging to avoid replaying a 0.1.0.8 version bump over the current 0.1.0.13.

@TroyHernandez
TroyHernandez deleted the cran-presubmission branch July 24, 2026 17:45
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