Skip to content

WIP: Fix and standardize @examples (\dontrun{})#3798

Open
S1DDHEY wants to merge 9 commits intoPecanProject:developfrom
S1DDHEY:fix/rethink-dontrun
Open

WIP: Fix and standardize @examples (\dontrun{})#3798
S1DDHEY wants to merge 9 commits intoPecanProject:developfrom
S1DDHEY:fix/rethink-dontrun

Conversation

@S1DDHEY
Copy link
Contributor

@S1DDHEY S1DDHEY commented Feb 1, 2026

Description

fixes #3797
This WIP PR starts cleaning up Roxygen @examples across PEcAn packages.

So far this includes:

  • Fixing syntactic errors that cause pkgdown example parse failures
  • Making examples self-contained (no undefined symbols)
  • Converting non-R commands inside @examples to comments
  • Standardizing use of \dontrun{} vs \donttest{} based on side effects

Motivation and Context

Review Time Estimate

  • Immediately
  • Within one week
  • When possible

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • My name is in the list of CITATION.cff
  • I agree that PEcAn Project may distribute my contribution under any or all of
    • the same license as the existing code,
    • and/or the BSD 3-clause license.
  • I have updated the CHANGELOG.md.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@github-actions github-actions bot added the Models label Feb 4, 2026
@S1DDHEY
Copy link
Contributor Author

S1DDHEY commented Feb 8, 2026

I've added most of changes to @examples here, only the make document step remains to update the .Rd files which I'll do after this is reviewed.

There are also a few functions whose examples require specific inputs or domain knowledge that I don’t currently have. For those, I plan to open a separate issue.

@S1DDHEY S1DDHEY marked this pull request as ready for review February 8, 2026 06:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rethink \dontrun in examples

1 participant