Skip to content

Commit 608ffb3

Browse files
committed
Updades description of the popen module
Got rid of repeated "ph" abbriviateion everywhere except for examples Removed "Index" heading Added Subheadings for constructors, fields, and constants Fixes #5104
1 parent a99dacd commit 608ffb3

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

doc/reference/reference_lua/popen.rst

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,6 @@ object:
3030
syscall
3131
* :ref:`popen.new <popen-new>` to create a popen object with more specific options
3232

33-
Either function returns a handle which we will call ``popen_handle`` or ``ph``.
34-
With the handle one can execute methods.
35-
36-
===============================================================================
37-
Index
38-
===============================================================================
39-
4033
Below is a list of all ``popen`` functions and handle methods.
4134

4235
.. container:: table
@@ -87,6 +80,10 @@ Below is a list of all ``popen`` functions and handle methods.
8780
| <popen-handle_fields>` | |
8881
+--------------------------------------+---------------------------------+
8982

83+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
84+
popen module constructors
85+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
86+
9087
.. _popen-shell:
9188

9289
.. function:: shell(command [, mode])
@@ -95,8 +92,7 @@ Below is a list of all ``popen`` functions and handle methods.
9592

9693
:param string command: a command to run, mandatory
9794
:param string mode: communication mode, optional
98-
:return: (if success) a popen handle, which we will call
99-
``popen_handle`` or ``ph``
95+
:return: (if success) a popen handle
10096

10197
(if failure) ``nil, err``
10298

@@ -160,8 +156,7 @@ Below is a list of all ``popen`` functions and handle methods.
160156
mandatory; absolute path to the program is required when
161157
``opts.shell`` is false (default)
162158
:param table opts: table of options, optional
163-
:return: (if success) a popen handle, which we will call
164-
``popen_handle`` or ``ph``
159+
:return: (if success) a popen handle
165160

166161
(if failure) ``nil, err``
167162

@@ -251,7 +246,7 @@ Below is a list of all ``popen`` functions and handle methods.
251246
| | | or when Lua GC collects the handle. |
252247
+----------------------+----------------+-------------------------------------------+
253248

254-
The returned ``ph`` handle provides a
249+
The returned ``popen_handle`` handle provides a
255250
:ref:`popen_handle:close() <popen-close>` method for explicitly
256251
releasing all occupied resources, including the child process
257252
itself if ``opts.keep_child`` is not set). However, if the ``close()``
@@ -835,6 +830,10 @@ Below is a list of all ``popen`` functions and handle methods.
835830
means success for a caller. The return values are purely
836831
informational: they are for logging or some kind of reporting.
837832

833+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
834+
popen handle fields
835+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
836+
838837
.. _popen-handle_fields:
839838

840839
**Handle fields**
@@ -851,6 +850,10 @@ Below is a list of all ``popen`` functions and handle methods.
851850
852851
See :ref:`popen_handle:info() <popen-info>` for details.
853852

853+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
854+
popen module constants
855+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
856+
854857
.. _popen-constants:
855858

856859
**Module constants**

0 commit comments

Comments
 (0)