Skip to content

chore(typing): address ty diagnostics in docs/ (and decide notebook policy) #1981

@jxnl

Description

@jxnl

Docs are currently excluded from ty checks (and notebooks are excluded via **/*.ipynb).

Current status

  • uv run ty check docs reports 1 diagnostic:
    • docs/hooks/hide_lines.py:26 error[invalid-assignment] (monkeypatch assignment)

Goal

  • Decide whether we want ty coverage for:
    • docs/hooks/*.py only, and/or
    • notebooks (docs/tutorials/*.ipynb) via a different tool/process.

Possible approach

  • Fix docs/hooks/hide_lines.py with a targeted cast or ignore for the monkeypatch assignment.
  • Keep notebooks excluded (or move notebook validation to a separate docs test that doesn’t run through ty).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationpythonPull requests that update python code

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions