-
-
Notifications
You must be signed in to change notification settings - Fork 32k
Random walk documentation improvements #107432
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Labels
Comments
evildmp
added a commit
to evildmp/cpython
that referenced
this issue
Jul 29, 2023
https://docs.python.org/3/howto/pyporting.html#porting-python-2-code-to-python-3 was written for another time. In this patch: * material that frames Python 3 as "new" is removed * descriptions and directions have been trimmed
evildmp
added a commit
to evildmp/cpython
that referenced
this issue
Jul 29, 2023
Body text in https://docs.python.org/3/howto/annotations.html was indented throughout, and was being rendered in blockquote elements.
evildmp
added a commit
to evildmp/cpython
that referenced
this issue
Jul 29, 2023
…unctional.html This is not a how-to guide; the title has been changed. A future commit should move the document out of /howto This patch removes comments about what the author thinks the reader is familiar with, and the first-person voice that sometimes appeared. Some wording that dated the document has been changed.
This was referenced Aug 5, 2023
hugovk
pushed a commit
that referenced
this issue
Aug 5, 2023
gh-107432 Fix incorrect indentation in annotations document Body text in https://docs.python.org/3/howto/annotations.html was indented throughout, and was being rendered in blockquote elements.
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Aug 5, 2023
…nGH-107445) pythongh-107432 Fix incorrect indentation in annotations document Body text in https://docs.python.org/3/howto/annotations.html was indented throughout, and was being rendered in blockquote elements. (cherry picked from commit 5e2746d) Co-authored-by: Daniele Procida <[email protected]>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Aug 5, 2023
…nGH-107445) pythongh-107432 Fix incorrect indentation in annotations document Body text in https://docs.python.org/3/howto/annotations.html was indented throughout, and was being rendered in blockquote elements. (cherry picked from commit 5e2746d) Co-authored-by: Daniele Procida <[email protected]>
hugovk
pushed a commit
that referenced
this issue
Aug 5, 2023
…07445) (#107655) gh-107432 Fix incorrect indentation in annotations HOWTO (GH-107445) gh-107432 Fix incorrect indentation in annotations document Body text in https://docs.python.org/3/howto/annotations.html was indented throughout, and was being rendered in blockquote elements. (cherry picked from commit 5e2746d) Co-authored-by: Daniele Procida <[email protected]>
Yhg1s
pushed a commit
that referenced
this issue
Aug 5, 2023
…07445) (#107654) gh-107432 Fix incorrect indentation in annotations HOWTO (GH-107445) gh-107432 Fix incorrect indentation in annotations document Body text in https://docs.python.org/3/howto/annotations.html was indented throughout, and was being rendered in blockquote elements. (cherry picked from commit 5e2746d) Co-authored-by: Daniele Procida <[email protected]>
This was referenced Aug 24, 2023
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Aug 24, 2023
…onGH-107434) https://docs.python.org/3/howto/pyporting.htmlGH-porting-python-2-code-to-python-3 was written for another time. In this patch: - material that frames Python 3 as "new" is removed - descriptions and directions have been trimmed (cherry picked from commit 809ea7c) Co-authored-by: Daniele Procida <[email protected]>
encukou
pushed a commit
that referenced
this issue
Aug 24, 2023
https://docs.python.org/3/howto/pyporting.html#porting-python-2-code-to-python-3 was written for another time. In this patch: - material that frames Python 3 as "new" is removed - descriptions and directions have been trimmed
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Aug 24, 2023
…onGH-107434) https://docs.python.org/3/howto/pyporting.htmlGH-porting-python-2-code-to-python-3 was written for another time. In this patch: - material that frames Python 3 as "new" is removed - descriptions and directions have been trimmed (cherry picked from commit 809ea7c) Co-authored-by: Daniele Procida <[email protected]>
Yhg1s
pushed a commit
that referenced
this issue
Aug 24, 2023
…107434) (#108409) gh-107432 Update Porting Python 2 Code to Python 3 how-to (GH-107434) https://docs.python.org/3/howto/pyporting.htmlGH-porting-python-2-code-to-python-3 was written for another time. In this patch: - material that frames Python 3 as "new" is removed - descriptions and directions have been trimmed (cherry picked from commit 809ea7c) Co-authored-by: Daniele Procida <[email protected]>
ambv
pushed a commit
that referenced
this issue
Aug 24, 2023
…107434) (#108410) https://docs.python.org/3/howto/pyporting.html was written for another time. In this patch: - material that frames Python 3 as "new" is removed - descriptions and directions have been trimmed (cherry picked from commit 809ea7c) Co-authored-by: Daniele Procida <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
Uh oh!
There was an error while loading. Please reload this page.
Across the documentation there are numerous examples of scope for improvement. Many of these could be described as housekeeping opportunities - documentation that is fundamentally sound, but needs to be updated and tidied up.
An example is Porting Python 2 Code to Python 3, which was written in a different era.
These are the kind of thing that will be discovered in a random walk through the documentation, one thing leading to another. A random walk will also uncover (often small) possibilities for improvement that would otherwise likely hide unnoticed in quiet corners.
Pitch
I propose taking a random walk through the documentation, finding and taking low-hanging fruit where I go. As well as the value of the fixes themselves, the activity and discussion of issues as they come up with bring further opportunities to the surface, and place them in front of more eyes.
Discoveries and suggestions
Linked PRs
Doc/howto/functional.rst
#107449The text was updated successfully, but these errors were encountered: