Skip to content

Low: Miscellaneous code quality issues from AGENTS.md audit #110

Description

@shinaoka

Triage (origin/main 834d0be): mixed / actionable。QuanticsGrids.jl/QuanticsTCI.jl の @autodocs 不在は設計判断の余地あり。

AGENTS.md 監査で見つかった優先度低の項目群です。

1. SKELETON_PHASE に docstring がない (src/Tensor4all.jl:17)

const SKELETON_PHASE = true

AGENTS.md の「Every exported type and function should have a concise docstring」に違反。この const が何を意味し、いつ false になるのかを説明する docstring が必要。

2. 7 つのサブモジュールにモジュールレベルの docstring がない

TensorNetworks, ITensorCompat, SimpleTT, TensorCI, QuanticsGrids, QuanticsTCI, QuanticsTransform の各 module ... end ブロックに docstring がない。

3. docs/make.jlwarnonly=[:missing_docs] 設定

checkdocs=:exports で exported symbol の docstring 不足をチェックしているが、warnonly=[:missing_docs] により警告止まりで CI が失敗しない。

4. check_autodocs_coverage.jl が exported but undocumented シンボルを検出しない

CI スクリプトは「docstring がある public シンボル」のみをチェックし、「export されているが undocumented なシンボル」はチェックしない。AGENTS.md の「public (exported or documented) symbols」の定義と乖離がある。

5. QuanticsGrids.jl / QuanticsTCI.jl の @autodocs 未掲載 (設計判断)

docs/src/api.md の "Adopted Modules" で upstream docs への導線として明示されており、ローカル @autodocs に載せない判断はありえる。Tensor4all 側で wrapper module 自体を docs 化するかの設計判断として扱う。

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions