← 返回首页
Rename Doc/README.txt to Doc/README.rst and add formatting · Pull Request #104 · python/cpython · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

Rename Doc/README.txt to Doc/README.rst and add formatting#104

Merged
vstinner merged 7 commits into
masterfrom
unknown repository
Feb 15, 2017
Merged

Rename Doc/README.txt to Doc/README.rst and add formatting#104
vstinner merged 7 commits into
masterfrom
unknown repository

Conversation

ghost commented Feb 15, 2017

Copy link
Copy Markdown

I have simply updated the document and its references to README.rst (thanks to whoever formatted it).

ghost mentioned this pull request Feb 15, 2017
Closed

ghost commented Feb 15, 2017

Copy link
Copy Markdown
Author

CC: @zware @Haypo @methane

ghost changed the title Rename Doc/README.txt to Doc/README.rst Rename Doc/README.txt to Doc/README.rst and add formatting Feb 15, 2017
methane reviewed Feb 15, 2017
View reviewed changes
Comment thread Doc/README.rst
both style and markup, is available in the "Documenting Python" chapter of the
developers guide <https://docs.python.org/devguide/documenting.html>.
both style and markup, is available in the "`Documenting Python <https://docs.python.org/devguide/documenting.html>`_" chapter of the
developers guide.

methane Feb 15, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

folding long line is preferred.

ghost commented Feb 15, 2017

Copy link
Copy Markdown
Author

@methane That line is now folded.

zware commented Feb 15, 2017

Copy link
Copy Markdown
Member

Has anyone tested to make sure the docs build doesn't pick up and build README.rst? I'm not sure that it would be harmful, but would be unnecessary.

methane commented Feb 15, 2017

Copy link
Copy Markdown
Member

@zware nice catch!

@rogersachan There are two problem.

  • make check reports error. -i README.rst should be added to rstlint argument in Makefile.
  • make html reports warning README.rst:: WARNING: document isn't included in any toctree. Please add README.rst to exclude_patterns in conf.py.

(I feel markdown is better for README now. But I was too late.)

methane previously requested changes Feb 15, 2017
View reviewed changes

methane left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Please update Makefile and conf.py

zware mentioned this pull request Feb 15, 2017
Merged
brettcannon mentioned this pull request Feb 15, 2017
Closed

ghost commented Feb 15, 2017

Copy link
Copy Markdown
Author

@methane I have made the requested changes.

vstinner requested changes Feb 15, 2017
View reviewed changes
Comment thread Doc/README.rst Outdated
Bugs in the toolset should be reported in the Sphinx bug tracker at
https://www.bitbucket.org/birkenfeld/sphinx/issues/.
Bugs in the toolset should be reported in the
`Sphinx bug tracker <https://www.bitbucket.org/birkenfeld/sphinx/issues/>`_.

vstinner Feb 15, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

This link is outdated, it's now https://github.com/sphinx-doc/sphinx/issues

ghost commented Feb 15, 2017

Copy link
Copy Markdown
Author

@Haypo I have made the requested changes.

vstinner dismissed methane’s stale review February 15, 2017 22:53

"methane: @rogersachan There are two problem." these issues have been fixed

vstinner merged commit b3f1f59 into python:master Feb 15, 2017

vstinner commented Feb 15, 2017

Copy link
Copy Markdown
Member

Thanks, I merged your PR.

Right now http://sphinx-doc.org/ link displays "Diese Präsenz ist leider nicht verfügbar." error message in german, whereas http://www.sphinx-doc.org/ redirects to http://www.sphinx-doc.org/en/stable/ which is the expected website. But I hope that the error is only temporary. Otherwise, we can fix that later. I reported this issue on IRC.

zooba commented Feb 15, 2017

Copy link
Copy Markdown
Member

The Windows installer build picks up this readme file and distributes it as readme.txt (see Tools/msi/exe/exe_files.wxs, which now needs fixing).

I vote we should keep both so that we can distribute the file without rst formatting.

(As an aside, we also read the /LICENSE file, so if someone wants to come in and "fix" that too then they'll also need to update the installer.)

vstinner commented Feb 15, 2017

Copy link
Copy Markdown
Member

The Windows installer build picks up this readme file and distributes it as readme.txt (see Tools/msi/exe/exe_files.wxs, which now needs fixing).

This issue is about Doc/README.txt, but Tools/msi/exe/exe_files.wxs seems to refer to README.txt (root directory).

See PR #2 which renamed README.txt to README.rst. This PR was followed by PR #70, PR #73 and #21.

Is it common to provide README as plain text on Windows?

Would it be possible to provide a README formatted as HTML? It would look nicer than plain text, no? It would also allow to keep new features like images (well, "badges"). For example, on Linux I'm running manually "rst2html README.rst README.html".

zooba commented Feb 16, 2017

Copy link
Copy Markdown
Member

Ah, I see. This PR just modified the one at the root, which is why it showed up as the last commit for the file.

It doesn't matter whether it's common or not - it's a functional change that should have been on bpo and signed off by the RMs (who are responsible for keeping at least the header in the file up to date). This may just be Ned, depending on where the change was backported to.

vstinner commented Feb 16, 2017

Copy link
Copy Markdown
Member

I opened http://bugs.python.org/issue29579

6 hidden items Load more…
Mariatta pushed a commit to Mariatta/cpython that referenced this pull request Feb 25, 2017
[3.6] Rename Doc/README.txt to Doc/README.rst and add formatting (pyt… …
57a72f3
…honGH-104) (cherry picked from commit b3f1f59)
Mariatta mentioned this pull request Feb 25, 2017
Merged
akruis pushed a commit to akruis/cpython that referenced this pull request Sep 9, 2017
Issue python#104: global C variable slp_initial_tstate used before in… …
1f390cf
…itialisation Initialise slp_initial_tstate early, as in Stackless 2.7. https://bitbucket.org/stackless-dev/stackless/issues/104
akruis pushed a commit to akruis/cpython that referenced this pull request Sep 9, 2017
merge 3.3-slp (Stackless python#104)
81b62be
akruis pushed a commit to akruis/cpython that referenced this pull request Sep 9, 2017
merge 3.4-slp (Stackless python#104)
b5d9f15

miss-islington commented Sep 13, 2017

Copy link
Copy Markdown
Contributor

Thanks @rogersachan for the PR, and @Haypo for merging it 🌮🎉.. I'm working now to backport this PR to: 2.7.
🐍🍒⛏🤖

miss-islington commented Sep 13, 2017

Copy link
Copy Markdown
Contributor

Sorry, @rogersachan and @Haypo, I could not cleanly backport this to 2.7 due to a conflict.
Please backport using cherry_picker on command line.

vstinner commented Sep 13, 2017

Copy link
Copy Markdown
Member

I don't think that we need to backport this change to Python 2.7, so I removed the "needs backport to 2.7".

Mr3x33 added a commit to Mr3x33/cpython that referenced this pull request Sep 17, 2021
aaaa …
c755279
&python#60;&python#104;&python#49;&python#62;&python#104;&python#97;&python#104;&python#97;&python#60;&python#104;&python#50;&python#62;
ezio-melotti mentioned this pull request May 4, 2022
Merged
jaraco pushed a commit that referenced this pull request Dec 2, 2022
Update requests from 2.19.0 to 2.19.1 (#104)
92ae45c
gvanrossum mentioned this pull request Aug 22, 2023
Closed
ngoldbaum mentioned this pull request Sep 23, 2024
Closed
This was referenced Feb 11, 2025
Closed
Closed
sergey-miryanov mentioned this pull request Dec 18, 2025
Closed
SonicField added a commit to SonicField/cpython that referenced this pull request Apr 24, 2026
CLAUDE.md: add Pre-Edit Working-Tree Integrity discipline …
03a0dcb
Theologian 01:53:41Z draft per shepard 01:53:07Z + pythia python#104 (3) + supervisor 01:53:55Z GO. Adds proactive complement to existing gate python#3 (HEAD==binary AND tree-clean during build, REACTIVE detection at build-symptom). 4-step discipline for multi-file (≥2) edit sequences: 1. Pre-edit baseline snapshot 2. Mid-edit integrity check (HALT on unexpected change) 3. Pre-commit verification (HALT if staged diff diverges) 4. HALT response (clean-HEAD restore + observed-but-not-attributed report; do NOT auto-resume) Rationale: 5+ prior incidents caused gate failures + false BUILD PASS + ARM64 build BLOCK (D-1775810621, D-1775669703, D-1776414469, D-1776434533, D-1776887480/D-1776890644 per librarian 01:46:19Z). Triggered by 01:23Z external file-state revert during Tier 8 pilot Phase A execution (generalist 01:24:43Z observed-but-not-attributed HALT + clean-HEAD restore demonstrated the prescribed response). Doc-only +14L. No §3.5 BUILD MODE per touched-files rule (no builder*.{cpp,h,c} touched).
SonicField added a commit to SonicField/cpython that referenced this pull request Apr 24, 2026
docs: pythia python#104 + python#105 amendments to Tier 8 spec + CLAU… …
e8a83df
…DE.md Bundle of two theologian-authored doc amendments per supervisor dispositions: CLAUDE.md (+2L) — Pre-Edit WT Integrity 'undiagnosed-recurring' honest framing per pythia python#105 (3) + supervisor 02:13:12Z + theologian 02:13:54Z. Acknowledges 5+ prior incidents closed at SYMPTOM layer without root-cause attribution; this 4-step discipline codifies reactive HALT, not automated detection. Detection still depends on agent noticing mid-edit. Recurrence-prevention claim does not exceed what text mechanizes; automated detection feasibility (file-watcher / git-hook) is fixup PIR territory and remains open. docs/tier8-class-b-cport-migrate-arm-spec.md (+93/-20) — pythia python#104 amendments per theologian 01:38:08Z + supervisor 01:38:26Z + 01:37:05Z: §1.1 container-shape transferability caveat (vector-pilot ≠ hash/ stack/allocator-shape pattern transferability) §5 python#11 NEW: bridge-count-delta acceptance (each pilot must NET- SUBTRACT bridges OR honestly add with W45 fixture coverage) §5 python#12 NEW: Phase B FORCING-FUNCTION (Tier 8 SECOND-PILOT block_map_ Step A BLOCKED until exception_table_ Phase B commit lands) Bundle scope: doc-only, no §3.5 BUILD MODE (no builder*.{cpp,h,c} touched). Atomic per supervisor 02:13:12Z + 01:38:26Z dispositions. Push 28 advances the Tier 8 Phase A resume deadline tracker per theologian 02:13:54Z + supervisor 02:13:12Z (push 28 OR session-end whichever first). If Alex disposition + fixup PIR not received by deadline, theologian amends Phase 3 closure summary fa8dfef to remove Tier 8 pilot citation + re-opens pythia python#103 escape question.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

Footer

© 2026 GitHub, Inc.