From ac120a6dca0dd8054bef4557b5a9e32213be756d Mon Sep 17 00:00:00 2001 From: Artur Shiriev Date: Mon, 7 Sep 2026 09:24:32 +0300 Subject: [PATCH] docs: write README links absolute so they resolve on PyPI --- AGENTS.md | 5 ++++- README.md | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 9fde77f..4c09889 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -29,9 +29,12 @@ non-Provider attributes that exist to exercise the skip path. Real work **not scheduled** becomes a GitHub issue. +Every link in `README.md` must be absolute: `https://github.com/modern-python//blob/main/`, +or `.../tree/main/` for a directory. Never a relative path: `README.md` is also the PyPI long +description, and PyPI does not rewrite relative links, so a relative one 404s on the package page. + An invariant is a test whose name is the claim, with a docstring opening `INVARIANT:` and a second paragraph naming **what breaks it** — design rationale, not a report of what this one test catches. -Nothing enforces that docstring shape; it is read at review time. ## Agent skills diff --git a/README.md b/README.md index e8bd9dc..19cff8d 100644 --- a/README.md +++ b/README.md @@ -140,7 +140,7 @@ introspection cannot identify the caller. ## 📦 [PyPI](https://pypi.org/project/modern-di-pytest) -## 📝 [License](LICENSE) +## 📝 [License](https://github.com/modern-python/modern-di-pytest/blob/main/LICENSE) ## Part of `modern-python`