Skip to content

fix: expand check_docs coverage to full public API#3864

Open
SisyphusZheng wants to merge 2 commits into
freshframework:mainfrom
SisyphusZheng:fix/expand-check-docs
Open

fix: expand check_docs coverage to full public API#3864
SisyphusZheng wants to merge 2 commits into
freshframework:mainfrom
SisyphusZheng:fix/expand-check-docs

Conversation

@SisyphusZheng

@SisyphusZheng SisyphusZheng commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Currently tools/check_docs.ts only validates packages/fresh/src/error.ts. The checkDocs() library is fully capable of checking multiple specifiers — it runs deno doc --lint plus custom assertions on @param, @return, @example tags, etc.

This PR expands the specifier list to cover the key public API entry points:

  • error.ts (HttpError - existing)
  • mod.ts (barrel export of all public symbols)
  • context.ts (Context class)
  • app.ts (App class)

Closes #3860

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.

tools/check_docs.ts only validates error.ts — should cover full public API

1 participant