Skip to content

Commit 2b0d2ca

Browse files
committed
docs(planning): codex review fixes for PR #4 phase specs
Three findings from a second codex:review pass on PR #27: 1. ROADMAP.md inline-summary v0.1.5 scope instead of linking to ../CHANGE-REQUEST-v0.1.5-launch.md. The CR document is intentionally untracked (it's a working planning artifact), so the link was dead from a fresh checkout's perspective. Replaced with a one-sentence summary of the five workstreams. 2. Phase 10 WNEW-01: define the kind filter and pagination params that the success criteria already exercise. Previous WNEW-01 listed only the version input, making the spec internally inconsistent with success criterion 3 (kind="deprecation") and WNEW-03 (pagination). 3. Phase 11 DETV2-01: parse the standard `version = X.Y[.Z]` key in pyvenv.cfg (written by python -m venv). version_info is the optional fallback, not the primary key as previously specified. Confirmed against the local .venv/pyvenv.cfg in the workspace.
1 parent 786ab16 commit 2b0d2ca

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

.planning/ROADMAP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Current
44

55
- **v0.1.4** — shipped (pre-PyPI; installed via `uvx --from git+…`)
6-
- **v0.1.5** — in progress (PyPI debut, repo rename to `python-stdlib-mcp`, positioning lockdown, benchmark harness, launch post). See [`CHANGE-REQUEST-v0.1.5-launch.md`](../CHANGE-REQUEST-v0.1.5-launch.md) for the full scope.
6+
- **v0.1.5** — in progress. Five coordinated workstreams: positioning lockdown ("canonical Python stdlib oracle for AI coding agents — always free, always MIT, token-frugal"); first PyPI publish via Trusted Publishing; GitHub repo rename to `python-stdlib-mcp` (PyPI package name stays `python-docs-mcp-server`); benchmark harness against competing docs MCPs; coordinated launch post on a personal blog, dev.to, and Show HN.
77

88
## Backlog (post-v0.1.5)
99

.planning/phases/10-whatsnew/10-CONTEXT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Return the official "What's New in Python `<version>`" content as structured sec
1414

1515
## Requirements
1616

17-
- WNEW-01: Tool accepts a Python version string. Returns `{ "sections": [{title, anchor, body, kind}] }`.
17+
- WNEW-01: Tool signature: `whatsnew_for_version(version: str, kind: str | None = None, start_index: int = 0, max_sections: int = 20)`. `kind` filters to a single `kind` value (see WNEW-02); `start_index` + `max_sections` paginate the response. Returns `{ "sections": [{title, anchor, body, kind}], "next_start_index": int | None }`.
1818
- WNEW-02: `kind` enum: `new_module | new_feature | deprecation | removal | performance | syntax | other`.
19-
- WNEW-03: Token cost capped at ~2k per section; pagination supported via section index.
19+
- WNEW-03: Each section's `body` is capped at ~2k tokens. If a single section exceeds the cap, truncate with a clear marker and a `get_docs` hint. Pagination via `start_index` / `next_start_index` round-trips.
2020

2121
## Success criteria
2222

.planning/phases/11-detect-venv/11-CONTEXT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Make `detect_python_version` venv-aware: report the Python version of the *activ
1515

1616
## Requirements
1717

18-
- DETV2-01: Detect active venv via the `VIRTUAL_ENV` env var; if present, read `$VIRTUAL_ENV/pyvenv.cfg` for `version_info`.
18+
- DETV2-01: Detect active venv via the `VIRTUAL_ENV` env var; if present, read `$VIRTUAL_ENV/pyvenv.cfg` and parse the `version = X.Y[.Z]` key (the standard key written by `python -m venv`). Fall back to `version_info` only if `version` is absent — some tools write that variant.
1919
- DETV2-02: Detect `.venv/` or `venv/` directories in cwd or its ancestors (up to project root).
2020
- DETV2-03: Detect `uv`'s `.venv` and `poetry`'s `.venv` patterns.
2121
- DETV2-04: Preserve v1 fallback chain unchanged below the new venv checks.

0 commit comments

Comments
 (0)