Code Style¶
Formatting and linting¶
vcspull uses ruff for formatting and linting.
$ uv run ruff format .
$ uv run ruff check . --fix --show-fixes
Type checking¶
mypy runs in strict mode.
$ uv run mypy
Docstrings¶
Follow NumPy docstring convention.
Imports¶
Use
from __future__ import annotationsin every file.Prefer namespace imports for stdlib:
import pathlibnotfrom pathlib import Path.Use
import typing as tand access viat.NamedTuple,t.TYPE_CHECKING, etc.