Skip to content

refactor: document public API helpers#1

Merged
suzunn merged 1 commit into
mainfrom
refactor/document-public-api
Jun 15, 2026
Merged

refactor: document public API helpers#1
suzunn merged 1 commit into
mainfrom
refactor/document-public-api

Conversation

@suzunn

@suzunn suzunn commented Jun 15, 2026

Copy link
Copy Markdown
Owner

Summary

  • I added JSDoc to the public CLI, scanner, cleaner, filter, catalog, report, and unit helper exports.
  • I documented the safety guarantees around rescanning removal targets and the scan/filter/report contracts.

Checks

  • npm run ci
  • git diff --check

@suzunn suzunn added the documentation Improvements or additions to documentation label Jun 15, 2026
@suzunn
suzunn merged commit bd33895 into main Jun 15, 2026
8 checks passed
@suzunn
suzunn deleted the refactor/document-public-api branch June 15, 2026 14:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant