Updades description of the popen module #5117
Open
+98
−52
Conversation
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
Got rid of repeated "ph" abbriviateion everywhere except for examples Removed "Index" heading Added Subheadings for constructors, fields, and constants Fixes #5104
github-actions
bot
temporarily deployed
to
branch-gh-5104-update-popen-module-description
Changed datatype for popen handle objects from ``handle`` to ``userdata`` in parameters Added "object" word to ``popen.shell`` and ``popen.new`` constructors' successful results Fixes #5117
Totktonada
reviewed
May 19, 2025
github-actions
bot
temporarily deployed
to
branch-gh-5104-update-popen-module-description
Totktonada
reviewed
May 19, 2025
Totktonada
approved these changes
May 19, 2025
Changed headings structures and levels by comments for consistency Fixes #5117
github-actions
bot
temporarily deployed
to
branch-gh-5104-update-popen-module-description
Table names changed for headings by comment Fixes #5117
Totktonada
reviewed
May 19, 2025
| @@ -30,7 +30,9 @@ object: | |||
| syscall | |||
| * :ref:`popen.new <popen-new>` to create a popen object with more specific options | |||
|
|
|||
| Below is a list of all ``popen`` functions and handle methods. | |||
| Below are tables with summaries of ``popen`` constructors, constants, mrthods, and fields. | |||
Totktonada
reviewed
May 19, 2025
Comment on lines
104
to
112
| Popen handle fields: | ||
| ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
| popen module fields | ||
| ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
There was a problem hiding this comment.
These are handle fields, not module fields.
Totktonada
reviewed
May 19, 2025
Comment on lines
+70
to
+72
| ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
| popen module methods | ||
| ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
Totktonada
reviewed
May 19, 2025
Comment on lines
+35
to
+37
| ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
| popen module constructors | ||
| ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
There was a problem hiding this comment.
Should we really place these ToC tables into sub-sections? It is rendered this way:
Maybe we can do it in the following way (add the 'summary' words)?
- Overview
- popen module constructors summary
- popen module constants summary
- popen handle methods summary
- popen handle fields summary
- popen module constructors
- popen module constants
- popen handle methods
- popen handle fields
It seems less confusing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes Update
popen_handleterm description #5104