Skip to content

Commit 1694963

Browse files
authored
docs: write README links absolute so they resolve on PyPI (#191)
1 parent 2049357 commit 1694963

2 files changed

Lines changed: 5 additions & 2 deletions

File tree

‎AGENTS.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,12 @@ bindings, and `import_checker.py` owns every optional-dependency probe. Read the
2525

2626
Real work **not scheduled** becomes a GitHub issue.
2727

28+
Every link in `README.md` must be absolute: `https://github.com/modern-python/<repo>/blob/main/<path>`,
29+
or `.../tree/main/<path>` for a directory. Never a relative path: `README.md` is also the PyPI long
30+
description, and PyPI does not rewrite relative links, so a relative one 404s on the package page.
31+
2832
An invariant is a test whose name is the claim, with a docstring opening `INVARIANT:` and a second
2933
paragraph naming **what breaks it** — design rationale, not a report of what this one test catches.
30-
Nothing enforces that docstring shape; it is read at review time.
3134

3235
## Code style
3336

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ The following intentionally differ:
7575

7676
## 📦 [PyPI](https://pypi.org/project/lite-bootstrap)
7777

78-
## 📝 [License](LICENSE)
78+
## 📝 [License](https://github.com/modern-python/lite-bootstrap/blob/main/LICENSE)
7979

8080
## Part of `modern-python`
8181

0 commit comments

Comments
 (0)