I noticed in other docs that sometimes there is no mention of a function with
docstrings in the docs, even though there should be. I let GLM 5.2 code up a
script that, using the public API sampled via `griffe`, checks whether every
public function with a docstring is *somehow* mentioned in the docs.
There might be false-negatives due to \`my.function\` being regarded as a
doc mention although, technically, `[\`my.function\`]` is the only mention
that should count. I made this decision to work around cases where we use
`[[autodoc]]` for a whole module and the individual functions/classes are
only mentioned via simple \`backticks\`.
* check_doc_coverage: Enable dynamic __all__ retrieval
Before the script was not able to deal with packages that dynamically assemble
`__all__` which is now solved by evaluating the package (non-recursively) to
gather the public-facing API.
Running with transformers also made it clear that some code sections are explicitly
undocumented and need an exclude flag which now exists.
* Mention `shift_tokens_right` in docs
* Add doc coverage to CI
* Document new CI check
* Exit with error code 1 if things items are uncovered
githubnemo
86f5f96192