Skip to content

Complete and refresh XRLint documentation - #77

Open
forman wants to merge 1 commit into
mainfrom
forman/x-update_docs
Open

forman wants to merge 1 commit into
mainfrom
forman/x-update_docs

Conversation

@forman

@forman forman commented Sep 14, 2026

Copy link
Copy Markdown
Member

Description:

The documentation contained unfinished configuration sections and outdated descriptions of plugin discovery, rule names, and API behavior.

This PR completes every “Coming soon” section, refreshes the CLI/API and contributor guides, and adds runnable examples. The generated rule reference now includes qualified identifiers, preset names, and option schemas. It also documents existing ACDD preset limitations and a working strict-recommended override.

Includes corrected source docstrings and CLI help, a changelog entry, and the version update to 0.7.0.dev0.

Checklist (strike out non-applicable):

  • Changes documented in CHANGES.md
  • Related issue exists and is referred to in the PR description and CHANGES.md
  • Added docstrings and API docs for any new/modified user-facing classes and functions
  • Changes/features documented in docs/*
  • Unit-tests adapted/added for changes/features
  • Test coverage remains or increases (target 100%)

@forman
forman requested a review from clarasb September 14, 2026 15:07
@codecov

codecov Bot commented Sep 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.42%. Comparing base (b420ac8) to head (36843ff).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #77   +/-   ##
=======================================
  Coverage   99.42%   99.42%           
=======================================
  Files          75       75           
  Lines        2975     2975           
  Branches      432      432           
=======================================
  Hits         2958     2958           
  Misses          1        1           
  Partials       16       16           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

2 participants