diff options
author | Jakub Wilk <jwilk@jwilk.net> | 2017-03-17 19:38:28 +0100 |
---|---|---|
committer | Jakub Wilk <jwilk@jwilk.net> | 2017-03-17 19:41:49 +0100 |
commit | 67ba58b146400589fc810dbe40511a6a5e78b850 (patch) | |
tree | a735933b0d1d364b0cfb3c8a844ae90044ed60d2 /doc/source/f2py | |
parent | dc04055d464401ccb21269b1a972466bfbe67fbe (diff) | |
download | numpy-67ba58b146400589fc810dbe40511a6a5e78b850.tar.gz |
DOC: Fix typos
Diffstat (limited to 'doc/source/f2py')
-rw-r--r-- | doc/source/f2py/advanced.rst | 2 | ||||
-rw-r--r-- | doc/source/f2py/array_session.dat | 2 | ||||
-rw-r--r-- | doc/source/f2py/getting-started.rst | 2 | ||||
-rw-r--r-- | doc/source/f2py/python-usage.rst | 6 | ||||
-rw-r--r-- | doc/source/f2py/signature-file.rst | 6 |
5 files changed, 9 insertions, 9 deletions
diff --git a/doc/source/f2py/advanced.rst b/doc/source/f2py/advanced.rst index 7990a9ce4..c9f3862e6 100644 --- a/doc/source/f2py/advanced.rst +++ b/doc/source/f2py/advanced.rst @@ -25,7 +25,7 @@ In Python: Modifying the dictionary of a F2PY generated module =================================================== -The following example illustrates how to add an user-defined +The following example illustrates how to add a user-defined variables to a F2PY generated extension module. Given the following signature file diff --git a/doc/source/f2py/array_session.dat b/doc/source/f2py/array_session.dat index fa2d1db14..069530d03 100644 --- a/doc/source/f2py/array_session.dat +++ b/doc/source/f2py/array_session.dat @@ -39,7 +39,7 @@ copied an array using copy_ND_array: size=6, elsize=8 >>> print b [[ 1. 4. 5.] [ 2. 5. 6.]] ->>> a is b # a and b are acctually the same objects +>>> a is b # a and b are actually the same objects 1 >>> print arr.foo([1,2,3]) # different rank arrays are allowed copied an array using PyArray_CopyFromObject: size=3, elsize=8 diff --git a/doc/source/f2py/getting-started.rst b/doc/source/f2py/getting-started.rst index b54d1aba8..fffd61c45 100644 --- a/doc/source/f2py/getting-started.rst +++ b/doc/source/f2py/getting-started.rst @@ -170,7 +170,7 @@ one. .. include:: fib1.pyf :literal: -* Next, we'll teach F2PY that the argument ``n`` is a input argument +* Next, we'll teach F2PY that the argument ``n`` is an input argument (use ``intent(in)`` attribute) and that the result, i.e. the contents of ``a`` after calling Fortran function ``FIB``, should be returned to Python (use ``intent(out)`` attribute). In addition, an diff --git a/doc/source/f2py/python-usage.rst b/doc/source/f2py/python-usage.rst index f5f1d2304..79860173b 100644 --- a/doc/source/f2py/python-usage.rst +++ b/doc/source/f2py/python-usage.rst @@ -10,7 +10,7 @@ objects. All ``fortran`` type object have attribute ``_cpointer`` that contains CObject referring to the C pointer of the corresponding Fortran/C -function or variable in C level. Such CObjects can be used as an +function or variable in C level. Such CObjects can be used as a callback argument of F2PY generated functions to bypass Python C/API layer of calling Python functions from Fortran or C when the computational part of such functions is implemented in C or Fortran @@ -120,7 +120,7 @@ There are two types of proper-contiguous NumPy arrays: For one-dimensional arrays these notions coincide. -For example, an 2x2 array ``A`` is Fortran-contiguous if its elements +For example, a 2x2 array ``A`` is Fortran-contiguous if its elements are stored in memory in the following order:: A[0,0] A[1,0] A[0,1] A[1,1] @@ -279,7 +279,7 @@ but the following Python function ... return y_1,...,y_l -is provided by an user, and in addition, +is provided by a user, and in addition, :: diff --git a/doc/source/f2py/signature-file.rst b/doc/source/f2py/signature-file.rst index 6afcdeb8c..090a5eca5 100644 --- a/doc/source/f2py/signature-file.rst +++ b/doc/source/f2py/signature-file.rst @@ -56,7 +56,7 @@ A ``python module`` block has the following structure:: ]... end [python module [<modulename>]] -Here brackets ``[]`` indicate a optional part, dots ``...`` indicate +Here brackets ``[]`` indicate an optional part, dots ``...`` indicate one or more of a previous part. So, ``[]...`` reads zero or more of a previous part. @@ -326,7 +326,7 @@ The following attributes are used by F2PY: default. You need to specify ``required`` only if there is a need to disable automatic ``optional`` setting when ``<init_expr>`` is used. - If Python ``None`` object is used as an required argument, the + If Python ``None`` object is used as a required argument, the argument is treated as optional. That is, in the case of array argument, the memory is allocated. And if ``<init_expr>`` is given, the corresponding initialization is carried out. @@ -370,7 +370,7 @@ The following attributes are used by F2PY: slices data pointers may point to unallocated memory area. + ``out`` - The argument is considered as an return variable. It is appended + The argument is considered as a return variable. It is appended to the ``<returned variables>`` list. Using ``intent(out)`` sets ``intent(hide)`` automatically, unless also ``intent(in)`` or ``intent(inout)`` were used. |