Skip to content

Updades description of the popen module #5117

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: latest
Choose a base branch
from
Open

Updades description of the popen module #5117

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
608ffb3
Updades description of the popen module
AArdeev May 19, 2025
97d83fc
Updates datatype for popen handle objet in parameters
AArdeev May 19, 2025
dc3ddfd
Updates ``popen.rst`` structure of headings by comments
AArdeev May 19, 2025
3078414
Changes table names to headings in the Overview
AArdeev May 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions doc/reference/reference_lua/popen.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ object:

Below are tables with summaries of ``popen`` constructors, constants, mrthods, and fields.
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo: mrthods.


Popen module constructors:
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
popen module constructors
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comment on lines +35 to +37
Copy link
Contributor

@Totktonada Totktonada May 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Should we really place these ToC tables into sub-sections? It is rendered this way:

image

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.


.. container:: table

Expand All @@ -49,7 +51,9 @@ Popen module constructors:
| <popen-new>` | a new process |
+--------------------------------------+---------------------------------+

Popen module constants:
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
popen module constants
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. container:: table

Expand All @@ -63,7 +67,9 @@ Popen module constants:
| <popen-constants>` | |
+--------------------------------------+---------------------------------+

Popen handle methods:
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
popen module methods
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comment on lines +70 to +72
Copy link
Contributor

@Totktonada Totktonada May 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

These are handle methods.


.. container:: table

Expand Down Expand Up @@ -101,7 +107,9 @@ Popen handle methods:
| <popen-close>` | |
+--------------------------------------+---------------------------------+

Popen handle fields:
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
popen module fields
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Copy link
Contributor

Choose a reason for hiding this comment

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

These are handle fields, not module fields.


.. container:: table

Expand Down