Repository navigation
Add pdoc API reference - #23
Merged
Merged
Conversation
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Validation
Notes
pdoc still emits non-fatal warnings while resolving existing ty_extensions annotations, but documentation generation succeeds.