Skip to content

fix(docs): фактические ошибки в доках (logging --verbose, server-mode cancelled, имя пакета, api.md) + wiring lint #384

Description

@ArtVsMark

Часть эпика #381 (§ 4). Места, где документация утверждает то, чего в коде нет.

Scope — доки

  • 🔴 docs/logging.md:34 — убрать --verbose из активации диагностики: включает только --diagnostic (cli/__init__.py:415; --verbose управляет подробностью diff). Заодно :14 добавить уровень warning; :67 убрать нереализованное «маскируются до последних 4 символов»; :74–75 — «тест на редакцию — follow-up» устарело (tests/test_diag_log.py существует).
  • docs/server-mode.md:144–151 — статус cancelled существует (feat(web): отдельный статус "cancelled" в /api/v1/runs — решить до заморозки контракта #296, web/runs.py:56); список режимов /api/v1/runs — уже tests|playground|trace (не только bench/microbench); блок «контракт как в коде» :62–69 — добавить RunSpec.cancel_event, RunOutcome.cancelled/sandbox_violation.
  • docs/grader-workflow.md:265 — имя пакета stepik-grader[watch]stepik-python-grader[watch]. 🟣 Тот же баг в help-тексте cli/options.py:103.
  • docs/api.md:216–217/api/insights читает БД из Path.cwd() (insights_adapter.py:22), не из workspace; :194–195 — добавить поле docs_url в карточку /api/rules.
  • docs/trace-format.md:65–76 — добавить поле type у heap-объектов; «глубже — {repr}» → {type, repr} без kind.
  • docs/result-contract.md:114 — режимы run добавить microbench.
  • docs/glossary.md:32–36 — верх файла называет source-driven-скан «будущим», хотя §§ :185–284 документируют его как реализованный (feat(glossary): stdlib inventory scanner for official Python coverage #196feat(glossary): CLI and menu entrypoint for coverage scan #198). 🟣 docstring core/glossary.py:11 «~30 записей» → 28.
  • docs/adr/0001-server-mode.md:3 + индекс :29 — статус «Proposed» → «Accepted» (фазы 1–2 реализованы).
  • .github/PULL_REQUEST_TEMPLATE.md:28 и ISSUE_TEMPLATE/feature_task.md:27 — политика CHANGELOG под docs(changelog): политика краткости записей + ротация старых версий в архив #373: «в каждом PR» (CHECKPOINT — только на релиз), а не «при завершении фичи/спринта».
  • CLAUDE.md:131–134 — инвариант №4 ссылается на «fix(cli): --sandbox молча игнорируется при --serve #351» как на будущую задачу; fix(cli): --sandbox молча игнорируется при --serve #351 закрыт иным решением. Переформулировать («открытого issue на проброс sandbox в web нет»).

Scope — код (решить отдельно)

Критерии приёмки

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions