diff options
Diffstat (limited to 'doc/source/dev')
| -rw-r--r-- | doc/source/dev/development_advanced_debugging.rst | 8 | ||||
| -rw-r--r-- | doc/source/dev/development_environment.rst | 2 | ||||
| -rw-r--r-- | doc/source/dev/howto-docs.rst | 4 |
3 files changed, 7 insertions, 7 deletions
diff --git a/doc/source/dev/development_advanced_debugging.rst b/doc/source/dev/development_advanced_debugging.rst index fa4014fdb..18a7f6ae9 100644 --- a/doc/source/dev/development_advanced_debugging.rst +++ b/doc/source/dev/development_advanced_debugging.rst @@ -3,8 +3,8 @@ Advanced debugging tools ======================== If you reached here, you want to dive into, or use, more advanced tooling. -This is usually not necessary for first time contributers and most -day-to-day developement. +This is usually not necessary for first time contributors and most +day-to-day development. These are used more rarely, for example close to a new NumPy release, or when a large or particular complex change was made. @@ -25,7 +25,7 @@ narrow down. We do not expect any of these tools to be run by most contributors. However, you can ensure that we can track down such issues more easily easier: -* Tests should cover all code paths, incluing error paths. +* Tests should cover all code paths, including error paths. * Try to write short and simple tests. If you have a very complicated test consider creating an additional simpler test as well. This can be helpful, because often it is only easy to find which test @@ -112,7 +112,7 @@ where ``PYTHONMALLOC=malloc`` is necessary to avoid false positives from python itself. Depending on the system and valgrind version, you may see more false positives. ``valgrind`` supports "suppressions" to ignore some of these, and Python does -have a supression file (and even a compile time option) which may help if you +have a suppression file (and even a compile time option) which may help if you find it necessary. Valgrind helps: diff --git a/doc/source/dev/development_environment.rst b/doc/source/dev/development_environment.rst index 665198c69..37cf6f7af 100644 --- a/doc/source/dev/development_environment.rst +++ b/doc/source/dev/development_environment.rst @@ -122,7 +122,7 @@ source tree is to use:: NumPy uses a series of tests to probe the compiler and libc libraries for -funtions. The results are stored in ``_numpyconfig.h`` and ``config.h`` files +functions. The results are stored in ``_numpyconfig.h`` and ``config.h`` files using ``HAVE_XXX`` definitions. These tests are run during the ``build_src`` phase of the ``_multiarray_umath`` module in the ``generate_config_h`` and ``generate_numpyconfig_h`` functions. Since the output of these calls includes diff --git a/doc/source/dev/howto-docs.rst b/doc/source/dev/howto-docs.rst index cc17a1feb..93fec509c 100644 --- a/doc/source/dev/howto-docs.rst +++ b/doc/source/dev/howto-docs.rst @@ -60,7 +60,7 @@ category, but other rewordings -- even for grammar -- require a judgment call, which raises the bar. Test the waters by first presenting the fix as an issue. Some functions/objects like numpy.ndarray.transpose, numpy.array etc. defined in -C-extension modules have their docstrings defined seperately in `_add_newdocs.py +C-extension modules have their docstrings defined separately in `_add_newdocs.py <https://github.com/numpy/numpy/blob/main/numpy/core/_add_newdocs.py>`__ ********************** @@ -72,7 +72,7 @@ Your frustrations using our documents are our best guide to what needs fixing. If you write a missing doc you join the front line of open source, but it's a meaningful contribution just to let us know what's missing. If you want to compose a doc, run your thoughts by the `mailing list -<https://mail.python.org/mailman/listinfo/numpy-discussion>`__ for futher +<https://mail.python.org/mailman/listinfo/numpy-discussion>`__ for further ideas and feedback. If you want to alert us to a gap, `open an issue <https://github.com/numpy/numpy/issues>`__. See `this issue <https://github.com/numpy/numpy/issues/15760>`__ for an example. |