add markdown linting and cut AGENTS.md back to rules
AGENTS.md was a per-module tour of the code, which restated what the code says and had already drifted: it described the example as emitting three inputs when it emits five. It is now the conventions an agent cannot infer -- dora version, uv, ruff, numpy docstrings, the platform requirement, act, and what not to do -- and nothing else. The gotchas it carried are explained at their point of use in the code instead. pymarkdown lints the markdown, configured in pyproject.toml and run in CI beside ruff. It caught a fenced block with no language and an over-long table row. ruff's pydocstyle convention moves to numpy. GEMINI.md is removed.
This commit is contained in:
+11
-2
@@ -24,7 +24,11 @@ dependencies = [
|
||||
dora-image-view = "dora_image_view.main:main"
|
||||
|
||||
[dependency-groups]
|
||||
dev = ["pytest >= 8.1", "ruff >= 0.9"]
|
||||
dev = [
|
||||
"pymarkdownlnt>=0.9.40",
|
||||
"pytest >= 8.1",
|
||||
"ruff >= 0.9",
|
||||
]
|
||||
|
||||
[build-system]
|
||||
requires = ["hatchling"]
|
||||
@@ -37,8 +41,13 @@ packages = ["dora_image_view"]
|
||||
extend-select = ["D", "I", "N", "RET", "UP"]
|
||||
|
||||
[tool.ruff.lint.pydocstyle]
|
||||
convention = "pep257"
|
||||
convention = "numpy"
|
||||
|
||||
[tool.ruff.lint.per-file-ignores]
|
||||
# Test names are the documentation here; a docstring would only repeat them.
|
||||
"tests/*" = ["D1"]
|
||||
|
||||
[tool.pymarkdown]
|
||||
# The prose here wraps near ruff's 88; 100 leaves room for a long link or table
|
||||
# row without inviting unwrapped paragraphs.
|
||||
plugins.md013.line_length = 100
|
||||
|
||||
Reference in New Issue
Block a user