docstrings
docstrings is an API & code reference docs skill for AI agents, published by CliMA in the EnsembleKalmanProcesses.jl repository on GitHub. Skillspace rates docstrings F (54/100) and it passed the safety scan; the rating is based on static analysis only.
Add or normalise Julia docstrings on public symbols (exported types, functions, and constants) so the package's public API is fully self-documenting and the Documenter.jl docs build passes its checkdocs check. After writing docstrings, also updates docs/src/API/ pages so every exported symbol appears exactly once, organised into logical categories, with stale entries removed. Invoke this skill whenever the user mentions: docstring, missing doc, undocumented symbol, API doc, checkdocs warning, docs/src/API, @docs block, or asks to document a type or function, sync the API pages, or keep the API index up to date. Also use it when the user asks to "write docs for" or "add docs to" source files, or when a CI failure mentions missing or incomplete docstrings.
- Grade
- F
- Quality
- 54 / 100
- Safety
- Passed
- GitHub stars
- 117
Unproven: rated by static analysis only, not yet compared head-to-head.
This rating describes the version of the repository we crawled; it may have changed since, so go by its current files.
Our review
- Architecture
- 74 / 100
- Maturity
- Basic: a single SKILL.md
- Security scan
- No issues found
- License
- Apache-2.0
- Adoption
- Adopted by 0 other repositories, in 0 collections
Not checked yet
- Category is a classifier prediction; no model has read this skill yet
- Not judged on the rubric yet (not a contender in its category)
- No blind task eval yet
- Scope (portable / vendor / repo-internal) not assessed; only the top of each category is read for scope
- Sibling files (scripts, references) not fetched; security scan covers SKILL.md only
Skillspace indexes and rates this skill; it does not host or endorse it. Run third-party skills at your own risk.