Skip to content

Add pdoc API reference - #23

Merged
trashhalo merged 3 commits into
mainfrom
docs/pdoc-api-reference
Aug 18, 2026
Merged

trashhalo merged 3 commits into
mainfrom
docs/pdoc-api-reference

Conversation

@trashhalo

Copy link
Copy Markdown
Contributor

Summary

  • add pdoc as a docs dependency with static and live-server tasks
  • add a Zed task for serving the API reference locally
  • add a module-reference landing page and expand module documentation
  • revise stale or misleading public docstrings and comments without changing runtime behavior

Validation

  • uv run ruff check on the revised modules
  • uv run ruff format --check on the revised modules
  • git diff --check
  • mise run docs

Notes

pdoc still emits non-fatal warnings while resolving existing ty_extensions annotations, but documentation generation succeeds.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds locally generated pdoc API documentation and improves module/API docstrings without runtime changes.

Changes:

  • Adds pdoc dependencies and documentation tasks.
  • Adds an API reference landing page and README instructions.
  • Expands documentation across core modules.

Reviewed changes

Copilot reviewed 16 out of 18 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
.gitignore Ignores generated docs.
.zed/tasks.json Adds live docs server task.
README.md Documents local API generation.
mise.toml Adds docs build task.
pyproject.toml Adds pdoc extras.
uv.lock Locks pdoc dependencies.
src/langset/__init__.py Adds module-reference links.
src/langset/bridge_emission.py Revises bridge documentation.
src/langset/data.py Expands dataset documentation.
src/langset/heads.py Documents auxiliary heads.
src/langset/loss.py Documents loss objectives.
src/langset/masking.py Documents masking APIs.
src/langset/modeling.py Expands model API documentation.
src/langset/selection.py Revises selection documentation.
src/langset/st_module.py Documents Sentence-Transformers integration.
src/langset/strategies.py Expands strategy documentation.
src/langset/trainer.py Expands trainer documentation.
src/langset/training_args.py Documents training configuration.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/langset/selection.py Outdated
Comment thread src/langset/trainer.py Outdated
Comment thread mise.toml
@trashhalo
trashhalo merged commit 4729659 into main Aug 18, 2026
1 check passed
@trashhalo
trashhalo deleted the docs/pdoc-api-reference branch August 18, 2026 18:23
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