You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(readme): widen PRE-PYPI markers to enclose full transient sections
Fixes C1+I1 from the PR #22 coherence review: previously the
<!-- PRE-PYPI --> markers wrapped only code fences, leaving
surrounding "Before/After PyPI publishing" headings and lead-in
sentences (including line 74's lowercase "until the PyPI package
is published") outside any marker. The committed cleanup regex
missed line 74, so post-launch a mechanical block-delete would
have left transient prose on the published README.
Each PRE-PYPI block now encloses its full transient region. The
RELEASE.md cleanup checklist references a perl one-liner for a
single-pass mechanical cleanup.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: .github/RELEASE.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -158,10 +158,9 @@ Complete these steps in order. Each step has a checkbox -- do not skip ahead.
158
158
### Post-PyPI Launch Pack Cleanup
159
159
160
160
-[ ] Remove every temporary PyPI pre-release block from `README.md`:
161
-
- Delete each `<!-- PRE-PYPI: ... -->` through `<!-- /PRE-PYPI -->` region,
162
-
including the marker comments and GitHub-source replacement commands
163
-
- Remove or rewrite stale "Before PyPI publishing" headings, "Until the first
164
-
PyPI release is published" text, and "After PyPI publishing" qualifiers
161
+
- Mechanical pass: delete every region from `<!-- PRE-PYPI:` to `<!-- /PRE-PYPI -->` (inclusive). Each block now encloses its surrounding heading + lead-in sentence + code, so a single pass produces a clean README.
<!-- PRE-PYPI: after the first PyPI publish, drop this "After PyPI publishing" heading so the section reads simply as "## Install" -->
94
95
### After PyPI publishing
96
+
<!-- /PRE-PYPI -->
95
97
96
98
Run directly with `uvx`:
97
99
@@ -114,13 +116,17 @@ shell or use `python -m uv ...` as a fallback for local contributor commands.
114
116
115
117
Build the local documentation index:
116
118
117
-
<!-- PRE-PYPI: replace this temporary GitHubsource command after the first PyPI publish -->
119
+
<!-- PRE-PYPI: remove the GitHub-source build-index command and the "After PyPI publishing" lead-in after the first PyPI publish; the post-PyPI code fence below survives-->
<!-- PRE-PYPI: replace this temporary GitHubsource command after the first PyPI publish -->
153
+
<!-- PRE-PYPI: remove the GitHub-source config and the "After PyPI publishing, use:" lead-in after the first PyPI publish; the post-PyPI config fence below survives-->
148
154
```json
149
155
{
150
156
"mcpServers": {
@@ -159,9 +165,9 @@ Add this to your Claude Desktop configuration file:
159
165
}
160
166
}
161
167
```
162
-
<!-- /PRE-PYPI -->
163
168
164
169
After PyPI publishing, use:
170
+
<!-- /PRE-PYPI -->
165
171
166
172
```json
167
173
{
@@ -181,7 +187,7 @@ Restart Claude Desktop after editing the config file.
181
187
Add this to your Cursor MCP settings (`.cursor/mcp.json` in your project or
182
188
global settings):
183
189
184
-
<!-- PRE-PYPI: replace this temporary GitHubsource command after the first PyPI publish -->
190
+
<!-- PRE-PYPI: remove the GitHub-source config and the "After PyPI publishing, use:" lead-in after the first PyPI publish; the post-PyPI config fence below survives-->
185
191
```json
186
192
{
187
193
"mcpServers": {
@@ -196,9 +202,9 @@ global settings):
196
202
}
197
203
}
198
204
```
199
-
<!-- /PRE-PYPI -->
200
205
201
206
After PyPI publishing, use:
207
+
<!-- /PRE-PYPI -->
202
208
203
209
```json
204
210
{
@@ -215,15 +221,15 @@ After PyPI publishing, use:
215
221
216
222
Add this to `.codex/config.toml`:
217
223
218
-
<!-- PRE-PYPI: replace this temporary GitHubsource command after the first PyPI publish -->
224
+
<!-- PRE-PYPI: remove the GitHub-source config and the "After PyPI publishing, use:" lead-in after the first PyPI publish; the post-PyPI config fence below survives-->
@@ -313,15 +319,15 @@ search, or silently fall back to unofficial community mirrors.
313
319
314
320
## Diagnostics
315
321
322
+
<!-- PRE-PYPI: remove the GitHub-source doctor invocation and "After PyPI publishing:" lead-in after the first PyPI publish; the post-PyPI code fence below survives -->
316
323
Before PyPI publishing, run `doctor` from the GitHub source package:
317
324
318
-
<!-- PRE-PYPI: replace this temporary GitHub source command after the first PyPI publish -->
319
325
```bash
320
326
uvx --from git+https://github.com/ayhammouda/python-docs-mcp-server.git python-docs-mcp-server doctor
321
327
```
322
-
<!-- /PRE-PYPI -->
323
328
324
329
After PyPI publishing:
330
+
<!-- /PRE-PYPI -->
325
331
326
332
```bash
327
333
uvx python-docs-mcp-server doctor
@@ -331,16 +337,16 @@ This checks the runtime Python version, SQLite FTS5, cache/index paths, disk
331
337
space, and whether the current interpreter has the `venv`/`ensurepip` support
332
338
needed by `build-index`.
333
339
340
+
<!-- PRE-PYPI: remove the GitHub-source validate-corpus invocation and "After PyPI publishing:" lead-in after the first PyPI publish; the post-PyPI code fence below survives -->
334
341
Before PyPI publishing, validate an existing index from the GitHub source
335
342
package:
336
343
337
-
<!-- PRE-PYPI: replace this temporary GitHub source command after the first PyPI publish -->
0 commit comments