# `scripts.check_docs_coverage`

Fail when source symbols or public explanations disappear from the docs.

[View the complete module source at #L1-L187](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/scripts/check_docs_coverage.py#L1-L187).

## API details

Each callable below includes its exact signature, type annotations, inputs, defaults, return contract, documented exceptions, implementation source, and parsed docstring sections when the source provides them.

::: scripts.check_docs_coverage
    options:
      members:
        - main
      filters: []
      show_if_no_docstring: true

## Complete contract reference

Expand any definition for its exact inputs, annotations, defaults, return contract, directly raised exceptions, source-grounded behavior, and immutable line link. This section includes private and nested definitions that ordinary API generators omit.

<details class="api-contract" id="contract-scripts.check_docs_coverage.main" markdown="1">
<summary><code>scripts.check_docs_coverage.main</code> · function</summary>

```python
scripts.check_docs_coverage.main() -> int
```

Validate module coverage, symbol coverage, and public docstring coverage.

**Parameters**

This callable has no explicit inputs.

**Returns**

- Type: `int`
- Direct return expressions: `1`; `0`

**Exceptions and behavior**

Function `main` calls `build_inventory`, `build_repository_inventory`, `build_cli_inventory`, `render_cli_reference`; has 2 explicit return paths.
No direct `raise` statement appears in this definition.

[View source #L17-L183](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/scripts/check_docs_coverage.py#L17-L183).

</details>

## Complete symbol map

This map also includes private definitions and nested helpers. The signature column exposes every explicit input even when an internal helper has no dedicated parameter prose.

| Symbol | Kind | Signature and inputs | What it does | Source |
| --- | --- | --- | --- | --- |
| [`main`](#contract-scripts.check_docs_coverage.main) | function | `main() -> int` | Validate module coverage, symbol coverage, and public docstring coverage. | [#L17-L183](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/scripts/check_docs_coverage.py#L17-L183) |