diff options
Diffstat (limited to 'doc/source')
21 files changed, 28 insertions, 41 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 233f2e409..13341b56a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -84,7 +84,7 @@ themedir = os.path.join(os.pardir, 'scipy-sphinx-theme', '_theme') if not os.path.isdir(themedir): raise RuntimeError("Get the scipy-sphinx-theme first, " "via git submodule init && git submodule update") - + html_theme = 'scipy' html_theme_path = [themedir] @@ -109,7 +109,7 @@ else: html_additional_pages = { 'index': 'indexcontent.html', -} +} html_title = "%s v%s Manual" % (project, version) html_static_path = ['_static'] diff --git a/doc/source/dev/gitwash/configure_git.rst b/doc/source/dev/gitwash/configure_git.rst index 7e8cf8cbd..c62f33671 100644 --- a/doc/source/dev/gitwash/configure_git.rst +++ b/doc/source/dev/gitwash/configure_git.rst @@ -16,7 +16,7 @@ Here is an example ``.gitconfig`` file:: [user] name = Your Name email = you@yourdomain.example.com - + [alias] ci = commit -a co = checkout @@ -24,7 +24,7 @@ Here is an example ``.gitconfig`` file:: stat = status -a br = branch wdiff = diff --color-words - + [core] editor = vim @@ -33,7 +33,7 @@ Here is an example ``.gitconfig`` file:: You can edit this file directly or you can use the ``git config --global`` command:: - + git config --global user.name "Your Name" git config --global user.email you@yourdomain.example.com git config --global alias.ci "commit -a" diff --git a/doc/source/dev/gitwash/development_workflow.rst b/doc/source/dev/gitwash/development_workflow.rst index 8606b9018..523e04c0a 100644 --- a/doc/source/dev/gitwash/development_workflow.rst +++ b/doc/source/dev/gitwash/development_workflow.rst @@ -16,7 +16,7 @@ Basic workflow In short: -1. Update your ``master`` branch if it's not up to date. +1. Update your ``master`` branch if it's not up to date. Then start a new *feature branch* for each set of edits that you do. See :ref:`below <making-a-new-feature-branch>`. @@ -100,7 +100,7 @@ In git >= 1.7 you can ensure that the link is correctly set by using the ``--set-upstream`` option:: git push --set-upstream origin my-new-feature - + From now on git_ will know that ``my-new-feature`` is related to the ``my-new-feature`` branch in your own github_ repo. @@ -144,7 +144,7 @@ In more detail #. Check what the actual changes are with ``git diff`` (`git diff`_). #. Add any new files to version control ``git add new_file_name`` (see - `git add`_). + `git add`_). #. To commit all modified files into the local copy of your repo,, do ``git commit -am 'A commit message'``. Note the ``-am`` options to ``commit``. The ``m`` flag just signals that you're going to type a @@ -155,7 +155,7 @@ In more detail `tangled working copy problem`_. The section on :ref:`commit messages <writing-the-commit-message>` below might also be useful. #. To push the changes up to your forked repo on github_, do a ``git - push`` (see `git push`). + push`` (see `git push`). .. _writing-the-commit-message: diff --git a/doc/source/dev/gitwash/git_development.rst b/doc/source/dev/gitwash/git_development.rst index fb997abec..ee7787fec 100644 --- a/doc/source/dev/gitwash/git_development.rst +++ b/doc/source/dev/gitwash/git_development.rst @@ -12,4 +12,3 @@ Contents: development_setup configure_git development_workflow - diff --git a/doc/source/dev/gitwash/git_resources.rst b/doc/source/dev/gitwash/git_resources.rst index ae350806e..5f0c1d020 100644 --- a/doc/source/dev/gitwash/git_resources.rst +++ b/doc/source/dev/gitwash/git_resources.rst @@ -9,9 +9,9 @@ Tutorials and summaries * `github help`_ has an excellent series of how-to guides. * `learn.github`_ has an excellent series of tutorials -* The `pro git book`_ is a good in-depth book on git. +* The `pro git book`_ is a good in-depth book on git. * A `git cheat sheet`_ is a page giving summaries of common commands. -* The `git user manual`_ +* The `git user manual`_ * The `git tutorial`_ * The `git community book`_ * `git ready`_ - a nice series of tutorials diff --git a/doc/source/dev/gitwash/index.rst b/doc/source/dev/gitwash/index.rst index f3038721e..9d733dd1c 100644 --- a/doc/source/dev/gitwash/index.rst +++ b/doc/source/dev/gitwash/index.rst @@ -12,5 +12,3 @@ Contents: following_latest git_development git_resources - - diff --git a/doc/source/reference/arrays.datetime.rst b/doc/source/reference/arrays.datetime.rst index 82316144a..0e8050b01 100644 --- a/doc/source/reference/arrays.datetime.rst +++ b/doc/source/reference/arrays.datetime.rst @@ -322,7 +322,7 @@ dates, use :func:`busday_count`: >>> np.busday_count(np.datetime64('2011-07-18'), np.datetime64('2011-07-11')) -5 -If you have an array of datetime64 day values, and you want a count of +If you have an array of datetime64 day values, and you want a count of how many of them are valid dates, you can do this: .. admonition:: Example diff --git a/doc/source/reference/c-api.config.rst b/doc/source/reference/c-api.config.rst index 0989c53d7..0073b37a4 100644 --- a/doc/source/reference/c-api.config.rst +++ b/doc/source/reference/c-api.config.rst @@ -101,4 +101,3 @@ Platform information Returns the endianness of the current platform. One of :cdata:`NPY_CPU_BIG`, :cdata:`NPY_CPU_LITTLE`, or :cdata:`NPY_CPU_UNKNOWN_ENDIAN`. - diff --git a/doc/source/reference/c-api.coremath.rst b/doc/source/reference/c-api.coremath.rst index dba092a20..2d5aedc73 100644 --- a/doc/source/reference/c-api.coremath.rst +++ b/doc/source/reference/c-api.coremath.rst @@ -347,7 +347,7 @@ __ http://www.openexr.com/about.html Returns the value of x with the sign bit copied from y. Works for any value, including Inf and NaN. - + .. cfunction:: npy_half npy_half_spacing(npy_half h) This is the same for half-precision float as npy_spacing and npy_spacingf @@ -376,5 +376,4 @@ __ http://www.openexr.com/about.html .. cfunction:: npy_uint64 npy_halfbits_to_doublebits(npy_uint16 h) Low-level function which converts a 16-bit half-precision float - into a 64-bit double-precision float, stored as a uint64. - + into a 64-bit double-precision float, stored as a uint64. diff --git a/doc/source/reference/c-api.deprecations.rst b/doc/source/reference/c-api.deprecations.rst index a7960648a..a382017a2 100644 --- a/doc/source/reference/c-api.deprecations.rst +++ b/doc/source/reference/c-api.deprecations.rst @@ -14,14 +14,14 @@ Numarray. The core API originated with Numeric in 1995 and there are patterns such as the heavy use of macros written to mimic Python's C-API as well as account for compiler technology of the late 90's. There is also only a small group of volunteers who have had very little -time to spend on improving this API. +time to spend on improving this API. There is an ongoing effort to improve the API. It is important in this effort to ensure that code that compiles for NumPy 1.X continues to compile for NumPy 1.X. At the same time, certain API's will be marked as deprecated so that future-looking code can avoid these API's and -follow better practices. +follow better practices. Another important role played by deprecation markings in the C API is to move towards hiding internal details of the NumPy implementation. For those @@ -44,7 +44,7 @@ versions of NumPy should not have major C-API changes, however, that prevent code that worked on a previous minor release. For example, we will do our best to ensure that code that compiled and worked on NumPy 1.4 should continue to work on NumPy 1.7 (but perhaps with compiler -warnings). +warnings). To use the NPY_NO_DEPRECATED_API mechanism, you need to #define it to the target API version of NumPy before #including any NumPy headers. diff --git a/doc/source/reference/c-api.iterator.rst b/doc/source/reference/c-api.iterator.rst index 1e3565bc1..153792ac8 100644 --- a/doc/source/reference/c-api.iterator.rst +++ b/doc/source/reference/c-api.iterator.rst @@ -57,7 +57,7 @@ Here is a conversion table for which functions to use with the new iterator: :cfunc:`PyArray_ITER_GOTO1D` :cfunc:`NpyIter_GotoIndex` or :cfunc:`NpyIter_GotoIterIndex` :cfunc:`PyArray_ITER_NOTDONE` Return value of ``iternext`` function pointer -*Multi-iterator Functions* +*Multi-iterator Functions* :cfunc:`PyArray_MultiIterNew` :cfunc:`NpyIter_MultiNew` :cfunc:`PyArray_MultiIter_RESET` :cfunc:`NpyIter_Reset` :cfunc:`PyArray_MultiIter_NEXT` Function pointer from :cfunc:`NpyIter_GetIterNext` @@ -69,7 +69,7 @@ Here is a conversion table for which functions to use with the new iterator: :cfunc:`PyArray_MultiIter_NOTDONE` Return value of ``iternext`` function pointer :cfunc:`PyArray_Broadcast` Handled by :cfunc:`NpyIter_MultiNew` :cfunc:`PyArray_RemoveSmallest` Iterator flag :cdata:`NPY_ITER_EXTERNAL_LOOP` -*Other Functions* +*Other Functions* :cfunc:`PyArray_ConvertToCommonType` Iterator flag :cdata:`NPY_ITER_COMMON_DTYPE` ===================================== ============================================= @@ -649,7 +649,7 @@ Construction and Destruction -1 which means ``newaxis``. Within each ``op_axes[j]`` array, axes may not be repeated. The following example is how normal broadcasting applies to a 3-D array, a 2-D array, a 1-D array and a scalar. - + **Note**: Before NumPy 1.8 ``oa_ndim == 0` was used for signalling that that ``op_axes`` and ``itershape`` are unused. This is deprecated and should be replaced with -1. Better backward compatibility may be @@ -1229,7 +1229,7 @@ Functions For Iteration Gets the array of data pointers directly into the arrays (never into the buffers), corresponding to iteration index 0. - + These pointers are different from the pointers accepted by ``NpyIter_ResetBasePointers``, because the direction along some axes may have been reversed. diff --git a/doc/source/reference/routines.char.rst b/doc/source/reference/routines.char.rst index 41af947c8..7413e3615 100644 --- a/doc/source/reference/routines.char.rst +++ b/doc/source/reference/routines.char.rst @@ -84,4 +84,3 @@ Convenience class :toctree: generated/ chararray - diff --git a/doc/source/reference/routines.datetime.rst b/doc/source/reference/routines.datetime.rst index aab6f1694..875ad1124 100644 --- a/doc/source/reference/routines.datetime.rst +++ b/doc/source/reference/routines.datetime.rst @@ -17,4 +17,3 @@ Business Day Functions is_busday busday_offset busday_count - diff --git a/doc/source/reference/routines.dual.rst b/doc/source/reference/routines.dual.rst index 456fc5c02..4ed7098d6 100644 --- a/doc/source/reference/routines.dual.rst +++ b/doc/source/reference/routines.dual.rst @@ -45,4 +45,3 @@ Other .. autosummary:: i0 - diff --git a/doc/source/reference/routines.emath.rst b/doc/source/reference/routines.emath.rst index 9f6c2aaa7..c0c5b61fc 100644 --- a/doc/source/reference/routines.emath.rst +++ b/doc/source/reference/routines.emath.rst @@ -7,4 +7,3 @@ Mathematical functions with automatic domain (:mod:`numpy.emath`) available after :mod:`numpy` is imported. .. automodule:: numpy.lib.scimath - diff --git a/doc/source/reference/routines.ma.rst b/doc/source/reference/routines.ma.rst index 736755338..6eda37578 100644 --- a/doc/source/reference/routines.ma.rst +++ b/doc/source/reference/routines.ma.rst @@ -400,5 +400,3 @@ Miscellanea ma.ediff1d ma.indices ma.where - - diff --git a/doc/source/reference/routines.numarray.rst b/doc/source/reference/routines.numarray.rst index 36e5aa764..dab63fbdf 100644 --- a/doc/source/reference/routines.numarray.rst +++ b/doc/source/reference/routines.numarray.rst @@ -3,4 +3,3 @@ Numarray compatibility (:mod:`numpy.numarray`) ********************************************** .. automodule:: numpy.numarray - diff --git a/doc/source/reference/routines.oldnumeric.rst b/doc/source/reference/routines.oldnumeric.rst index d7f15bcfd..9cab2e9d9 100644 --- a/doc/source/reference/routines.oldnumeric.rst +++ b/doc/source/reference/routines.oldnumeric.rst @@ -5,4 +5,3 @@ Old Numeric compatibility (:mod:`numpy.oldnumeric`) .. currentmodule:: numpy .. automodule:: numpy.oldnumeric - diff --git a/doc/source/reference/swig.interface-file.rst b/doc/source/reference/swig.interface-file.rst index 8ef6c80ab..d835a4c4f 100644 --- a/doc/source/reference/swig.interface-file.rst +++ b/doc/source/reference/swig.interface-file.rst @@ -444,7 +444,7 @@ arrays with views into memory that is managed. See the discussion `here * ``(DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DIM_TYPE* DIM4, DATA_TYPE** ARGOUTVIEWM_ARRAY4)`` * ``(DATA_TYPE** ARGOUTVIEWM_FARRAY4, DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DIM_TYPE* DIM4)`` * ``(DIM_TYPE* DIM1, DIM_TYPE* DIM2, DIM_TYPE* DIM3, DIM_TYPE* DIM4, DATA_TYPE** ARGOUTVIEWM_FARRAY4)`` - + Output Arrays ````````````` diff --git a/doc/source/reference/swig.testing.rst b/doc/source/reference/swig.testing.rst index 8b19e4b28..decc681c5 100644 --- a/doc/source/reference/swig.testing.rst +++ b/doc/source/reference/swig.testing.rst @@ -15,8 +15,8 @@ this results in 1,427 individual unit tests that are performed when To facilitate this many similar unit tests, some high-level programming techniques are employed, including C and `SWIG`_ macros, -as well as Python inheritance. The purpose of this document is to describe -the testing infrastructure employed to verify that the ``numpy.i`` +as well as Python inheritance. The purpose of this document is to describe +the testing infrastructure employed to verify that the ``numpy.i`` typemaps are working as expected. Testing Organization @@ -57,9 +57,9 @@ Two-dimensional arrays are tested in exactly the same manner. The above description applies, but with ``Matrix`` substituted for ``Vector``. For three-dimensional tests, substitute ``Tensor`` for ``Vector``. For four-dimensional tests, substitute ``SuperTensor`` -for ``Vector``. +for ``Vector``. For the descriptions that follow, we will reference the -``Vector`` tests, but the same information applies to ``Matrix``, +``Vector`` tests, but the same information applies to ``Matrix``, ``Tensor`` and ``SuperTensor`` tests. The command ``make test`` will ensure that all of the test software is @@ -108,7 +108,7 @@ Testing SWIG Interface Files ``Vector.i`` is a `SWIG`_ interface file that defines python module ``Vector``. It follows the conventions for using ``numpy.i`` as described in this chapter. It defines a `SWIG`_ macro -``%apply_numpy_typemaps`` that has a single argument ``TYPE``. +``%apply_numpy_typemaps`` that has a single argument ``TYPE``. It uses the `SWIG`_ directive ``%apply`` to apply the provided typemaps to the argument signatures found in ``Vector.h``. This macro is then implemented for all of the data types supported by diff --git a/doc/source/user/basics.io.rst b/doc/source/user/basics.io.rst index 73947a2ef..54a65662b 100644 --- a/doc/source/user/basics.io.rst +++ b/doc/source/user/basics.io.rst @@ -5,4 +5,4 @@ I/O with Numpy .. toctree:: :maxdepth: 2 - basics.io.genfromtxt
\ No newline at end of file + basics.io.genfromtxt |