Skip to content

[DOC] ARCHITECTURE.md lists chainladder/tests/test_architecture.py, which is not in the repository #1651

Open

Description

@scks1

The directory tree in ARCHITECTURE.md lists a test file that isn't in the repository. Line 87 on main (a59efc9) reads

│       └── test_architecture.py    # Checks this file's directory tree against the real package

chainladder/tests/ on main holds only __init__.py and test_public_api.py. No commit on any branch has touched the path. On a full clone with every branch fetched, this prints nothing.

git log --all -- chainladder/tests/test_architecture.py

The line came in with 771de6d, merged in #1204. Its commit message says it adds the line "so test_package_directories_have_no_undocumented_members passes." That test name doesn't appear in any committed diff either, because git log --all -S test_package_directories_have_no_undocumented_members also prints nothing. The test may exist only in someone's local copy.

I checked all 76 entries in the tree against main, and this is the only one missing.

first tree line: chainladder-python/
entries checked: 76
missing: L87 chainladder/tests/test_architecture.py
Script
"""Compare the directory tree in ARCHITECTURE.md with the files in a checkout."""
import pathlib
import re
import sys

root = pathlib.Path(sys.argv[1])
lines = (root / "ARCHITECTURE.md").read_text(encoding="utf-8").splitlines()
start = lines.index("```") + 1
end = lines.index("```", start)
stack = []
missing = []
checked = 0
for n, line in enumerate(lines[start:end], start=start + 1):
    m = re.match(r"^([│ ]*)(?:├── |└── )(\S+)", line)
    if not m:
        continue
    depth = len(m.group(1)) // 4
    stack = stack[:depth]
    stack.append(m.group(2).rstrip("/"))
    rel = pathlib.Path(*stack)
    checked += 1
    if not (root / rel).exists():
        missing.append((n, str(rel)))
print("first tree line:", lines[start])
print("entries checked:", checked)
for n, rel in missing:
    print(f"missing: L{n} {rel}")

There are two ways to fix it.

  1. Delete line 87.
  2. Commit the test the line describes, if a copy still exists.

This looks small enough for a new contributor.

(This issue was written with Árbol, an AI assistant, under my direction.)

Activity

  1. henrydingliu commented on Nov 18, 2026

    @henrydingliu
    Member

    @genedan safe to delete?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    Priority

    None yet

    Scope

    None yet

    Effort

    None yet

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions