summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2020-10-02 07:05:29 -0600
committerGitHub <noreply@github.com>2020-10-02 07:05:29 -0600
commit5165c654dbb2b08e8a38ac437ab35611726bf26b (patch)
tree8b4f105f52224020229ea9c27834faaf33c5a2c6
parent5cae51e794d69dd553104099305e9f92db237c53 (diff)
parentd846cdabf5e0f76d53cb941bf075c21ecb98d573 (diff)
downloadnumpy-5165c654dbb2b08e8a38ac437ab35611726bf26b.tar.gz
Merge pull request #17424 from eric-wieser/_c.src-docs
DOC: Fix formatting issues in description of .c.src files
-rw-r--r--doc/DISTUTILS.rst.txt48
1 files changed, 24 insertions, 24 deletions
diff --git a/doc/DISTUTILS.rst.txt b/doc/DISTUTILS.rst.txt
index f1f270462..c58a423c0 100644
--- a/doc/DISTUTILS.rst.txt
+++ b/doc/DISTUTILS.rst.txt
@@ -394,37 +394,37 @@ and ``/**end repeat**/`` lines, which may also be nested using
consecutively numbered delimiting lines such as ``/**begin repeat1``
and ``/**end repeat1**/``:
-1. "/\**begin repeat "on a line by itself marks the beginning of
-a segment that should be repeated.
+1. ``/**begin repeat`` on a line by itself marks the beginning of
+ a segment that should be repeated.
2. Named variable expansions are defined using ``#name=item1, item2, item3,
-..., itemN#`` and placed on successive lines. These variables are
-replaced in each repeat block with corresponding word. All named
-variables in the same repeat block must define the same number of
-words.
+ ..., itemN#`` and placed on successive lines. These variables are
+ replaced in each repeat block with corresponding word. All named
+ variables in the same repeat block must define the same number of
+ words.
3. In specifying the repeat rule for a named variable, ``item*N`` is short-
-hand for ``item, item, ..., item`` repeated N times. In addition,
-parenthesis in combination with \*N can be used for grouping several
-items that should be repeated. Thus, #name=(item1, item2)*4# is
-equivalent to #name=item1, item2, item1, item2, item1, item2, item1,
-item2#
+ hand for ``item, item, ..., item`` repeated N times. In addition,
+ parenthesis in combination with ``*N`` can be used for grouping several
+ items that should be repeated. Thus, ``#name=(item1, item2)*4#`` is
+ equivalent to ``#name=item1, item2, item1, item2, item1, item2, item1,
+ item2#``.
-4. "\*/ "on a line by itself marks the end of the variable expansion
-naming. The next line is the first line that will be repeated using
-the named rules.
+4. ``*/`` on a line by itself marks the end of the variable expansion
+ naming. The next line is the first line that will be repeated using
+ the named rules.
5. Inside the block to be repeated, the variables that should be expanded
-are specified as ``@name@``
+ are specified as ``@name@``.
-6. "/\**end repeat**/ "on a line by itself marks the previous line
-as the last line of the block to be repeated.
+6. ``/**end repeat**/`` on a line by itself marks the previous line
+ as the last line of the block to be repeated.
7. A loop in the NumPy C source code may have a ``@TYPE@`` variable, targeted
-for string substitution, which is preprocessed to a number of otherwise
-identical loops with several strings such as INT, LONG, UINT, ULONG. The
-``@TYPE@`` style syntax thus reduces code duplication and maintenance burden by
-mimicking languages that have generic type support.
+ for string substitution, which is preprocessed to a number of otherwise
+ identical loops with several strings such as ``INT``, ``LONG``, ``UINT``,
+ ``ULONG``. The ``@TYPE@`` style syntax thus reduces code duplication and
+ maintenance burden by mimicking languages that have generic type support.
The above rules may be clearer in the following template source example:
@@ -464,13 +464,13 @@ The above rules may be clearer in the following template source example:
/**end repeat**/
-The preprocessing of generically typed C source files (whether in NumPy
+The preprocessing of generically-typed C source files (whether in NumPy
proper or in any third party package using NumPy Distutils) is performed
by `conv_template.py`_.
-The type specific C files generated (extension: .c)
+The type-specific C files generated (extension: ``.c``)
by these modules during the build process are ready to be compiled. This
form of generic typing is also supported for C header files (preprocessed
-to produce .h files).
+to produce ``.h`` files).
.. _conv_template.py: https://github.com/numpy/numpy/blob/master/numpy/distutils/conv_template.py