Skip to content

docs(parsers): keep compile-only API examples#798

Merged
abraemer merged 1 commit intomainfrom
docs/doctest-example-cleanup
Apr 27, 2026
Merged

docs(parsers): keep compile-only API examples#798
abraemer merged 1 commit intomainfrom
docs/doctest-example-cleanup

Conversation

@abraemer
Copy link
Copy Markdown
Collaborator

Summary

  • replace redundant doctests across parser and model docs with prose examples, while keeping the PackageParser, RecursionGuard, and register_parser! snippets as no_run examples
  • add direct RecursionGuard unit tests so its behavior stays covered by normal tests instead of documentation snippets
  • remove the dedicated doctest CI step from .github/workflows/check.yml now that doctests are no longer being used as meaningful test coverage

Issues

  • Covers:
  • Closes:

Scope and exclusions

  • Included: documentation cleanup for former doctests, RecursionGuard test coverage, and CI removal of the doctest step
  • Explicit exclusions: the unrelated dirty reference/scancode-toolkit submodule change in the worktree

Intentional differences from Python

  • None

Follow-up work

  • Created or intentionally deferred: repo docs that still mention doctests were left unchanged because this PR only removes the dedicated CI step and standardizes the remaining examples as compile-only docs

Expected-output fixture changes

  • Files changed: none
  • Why the new expected output is correct: no golden or expected-output fixtures changed in this branch

Replace redundant doctests with prose examples, keep the parser trait and registration snippets as no_run examples so rustdoc still compiles them locally, and drop the dedicated doctest CI step now that those examples are documentation rather than test coverage.

Signed-off-by: Adrian Braemer <bradrian@gmail.com>
@abraemer abraemer merged commit 95da847 into main Apr 27, 2026
15 checks passed
@abraemer abraemer deleted the docs/doctest-example-cleanup branch April 27, 2026 10:21
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