From 9931dbaa7e6364c3b676f05bfa2bd2afe3336997 Mon Sep 17 00:00:00 2001 From: Jon Dufresne Date: Tue, 6 Nov 2018 06:17:52 -0800 Subject: [PATCH] Trim trailing white space throughout the project Many editors clean up trailing white space on save. By removing it all in one go, it helps keep future diffs cleaner by avoiding spurious white space changes on unrelated lines. --- .coveragerc | 1 - .github/ISSUE_TEMPLATE/bug_report.md | 2 +- README.rst | 2 +- docs/source/bytes.rst | 1 - docs/source/chain.rst | 1 - docs/source/examples.rst | 2 +- docs/source/humansorted.rst | 1 - docs/source/index.rst | 1 - docs/source/index_humansorted.rst | 1 - docs/source/index_natsorted.rst | 1 - docs/source/index_realsorted.rst | 1 - docs/source/index_versorted.rst | 1 - docs/source/intro.rst | 4 ++-- docs/source/locale_issues.rst | 2 +- docs/source/natsort_key.rst | 1 - docs/source/natsort_keygen.rst | 1 - docs/source/natsorted.rst | 1 - docs/source/ns_class.rst | 1 - docs/source/order_by_index.rst | 1 - docs/source/realsorted.rst | 1 - docs/source/shell.rst | 5 ++--- docs/source/versorted.rst | 1 - setup.cfg | 5 ++--- 23 files changed, 10 insertions(+), 28 deletions(-) diff --git a/.coveragerc b/.coveragerc index 5c5f6439..64ca2b0f 100644 --- a/.coveragerc +++ b/.coveragerc @@ -14,4 +14,3 @@ exclude_lines = if __name__ == .__main__.: ignore_errors = True - diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index caebd68b..5d1335a6 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -16,7 +16,7 @@ A clear and concise description of what you expected to happen. - If the bug involves `LOCALE` or `humansorted`: - Is `PyICU` installed? - Do you have a locale set? If so, to what? - + **To Reproduce** Include a Minimum, Complete, Verifiable Example. If there is a traceback (or error message), **please** include the *entire* traceback (or error message), even if you think it is too big. diff --git a/README.rst b/README.rst index 8651128c..1fa128a1 100644 --- a/README.rst +++ b/README.rst @@ -316,7 +316,7 @@ Shell script ------------ ``natsort`` comes with a shell script called ``natsort``, or can also be called -from the command line with ``python -m natsort``. +from the command line with ``python -m natsort``. Requirements ------------ diff --git a/docs/source/bytes.rst b/docs/source/bytes.rst index c59d4ad5..b721e2f7 100644 --- a/docs/source/bytes.rst +++ b/docs/source/bytes.rst @@ -17,4 +17,3 @@ quickly decode `bytes` to `str` so that sorting is possible. .. autofunction:: as_ascii .. autofunction:: as_utf8 - diff --git a/docs/source/chain.rst b/docs/source/chain.rst index 5f597062..50536d08 100644 --- a/docs/source/chain.rst +++ b/docs/source/chain.rst @@ -13,4 +13,3 @@ used internally to :mod:`natsort`, and has been exposed publically for the convenience of the user. .. autofunction:: chain_functions - diff --git a/docs/source/examples.rst b/docs/source/examples.rst index db64bd0e..8a1fb297 100644 --- a/docs/source/examples.rst +++ b/docs/source/examples.rst @@ -90,7 +90,7 @@ you may need to use the ``ns.PATH`` option: Locale-Aware Sorting (Human Sorting) ------------------------------------ -.. note:: +.. note:: Please read :ref:`locale_issues` before using ``ns.LOCALE``, :func:`humansorted`, or :func:`index_humansorted`. diff --git a/docs/source/humansorted.rst b/docs/source/humansorted.rst index 35be19b9..af8db274 100644 --- a/docs/source/humansorted.rst +++ b/docs/source/humansorted.rst @@ -5,4 +5,3 @@ ============================ .. autofunction:: humansorted - diff --git a/docs/source/index.rst b/docs/source/index.rst index 9d7c81b3..3b0f63c2 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -25,4 +25,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` - diff --git a/docs/source/index_humansorted.rst b/docs/source/index_humansorted.rst index e143b674..c920cb6a 100644 --- a/docs/source/index_humansorted.rst +++ b/docs/source/index_humansorted.rst @@ -5,4 +5,3 @@ ================================== .. autofunction:: index_humansorted - diff --git a/docs/source/index_natsorted.rst b/docs/source/index_natsorted.rst index ea48f254..0402789c 100644 --- a/docs/source/index_natsorted.rst +++ b/docs/source/index_natsorted.rst @@ -5,4 +5,3 @@ ================================ .. autofunction:: index_natsorted - diff --git a/docs/source/index_realsorted.rst b/docs/source/index_realsorted.rst index 215c3e90..fdd66cf9 100644 --- a/docs/source/index_realsorted.rst +++ b/docs/source/index_realsorted.rst @@ -5,4 +5,3 @@ ================================= .. autofunction:: index_realsorted - diff --git a/docs/source/index_versorted.rst b/docs/source/index_versorted.rst index 07e266fb..0f27d13d 100644 --- a/docs/source/index_versorted.rst +++ b/docs/source/index_versorted.rst @@ -5,4 +5,3 @@ ================================ .. autofunction:: index_versorted - diff --git a/docs/source/intro.rst b/docs/source/intro.rst index ff477527..6cb4701e 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -148,7 +148,7 @@ This can be achieved with the :func:`~humansorted` function: You may find you need to explicitly set the locale to get this to work (as shown in the example). -Please see :ref:`locale_issues` and the Installation section +Please see :ref:`locale_issues` and the Installation section below before using the :func:`~humansorted` function. Further Customizing Natsort @@ -314,7 +314,7 @@ Shell script ------------ :mod:`natsort` comes with a shell script called :mod:`natsort`, or can also be called -from the command line with ``python -m natsort``. +from the command line with ``python -m natsort``. Requirements ------------ diff --git a/docs/source/locale_issues.rst b/docs/source/locale_issues.rst index 953f4927..c7990191 100644 --- a/docs/source/locale_issues.rst +++ b/docs/source/locale_issues.rst @@ -34,7 +34,7 @@ If you change locale, the old function will not work as expected. The `locale `_ library works with a global state. When :func:`~natsort.natsort_keygen` is called it does the best job that it can to make the returned function as static as possible and -independent of the global state, but the +independent of the global state, but the `strxfrm `_ function must access this global state to work; therefore, if you change locale and use ``ns.LOCALE`` then you should discard the old key. diff --git a/docs/source/natsort_key.rst b/docs/source/natsort_key.rst index 351b3517..ba9fe258 100644 --- a/docs/source/natsort_key.rst +++ b/docs/source/natsort_key.rst @@ -5,4 +5,3 @@ ============================ .. autofunction:: natsort_key - diff --git a/docs/source/natsort_keygen.rst b/docs/source/natsort_keygen.rst index b0d59885..288acf45 100644 --- a/docs/source/natsort_keygen.rst +++ b/docs/source/natsort_keygen.rst @@ -5,4 +5,3 @@ =============================== .. autofunction:: natsort_keygen - diff --git a/docs/source/natsorted.rst b/docs/source/natsorted.rst index 30b56927..88372f91 100644 --- a/docs/source/natsorted.rst +++ b/docs/source/natsorted.rst @@ -5,4 +5,3 @@ ========================== .. autofunction:: natsorted - diff --git a/docs/source/ns_class.rst b/docs/source/ns_class.rst index f604e3d8..e0b7c8ee 100644 --- a/docs/source/ns_class.rst +++ b/docs/source/ns_class.rst @@ -5,4 +5,3 @@ ==================== .. autoclass:: ns - diff --git a/docs/source/order_by_index.rst b/docs/source/order_by_index.rst index b1d76812..aab2b050 100644 --- a/docs/source/order_by_index.rst +++ b/docs/source/order_by_index.rst @@ -5,4 +5,3 @@ =============================== .. autofunction:: order_by_index - diff --git a/docs/source/realsorted.rst b/docs/source/realsorted.rst index 5af5b12b..8ef47177 100644 --- a/docs/source/realsorted.rst +++ b/docs/source/realsorted.rst @@ -5,4 +5,3 @@ =========================== .. autofunction:: realsorted - diff --git a/docs/source/shell.rst b/docs/source/shell.rst index 953c4232..17d1d7ba 100644 --- a/docs/source/shell.rst +++ b/docs/source/shell.rst @@ -88,7 +88,7 @@ to bad analysis. To remedy this, use ``natsort``:: $ natsort *.out mode744.43.out mode943.54.out - mode1000.35.out + mode1000.35.out mode1243.34.out $ natsort -t r *.out | xargs your_program @@ -114,7 +114,7 @@ options. These three options are used as follows:: mode1000.35.out mode1243.34.out mode744.43.out mode943.54.out $ natsort -t r *.out -f 900 1100 # Select only numbers between 900-1100 mode943.54.out - mode1000.35.out + mode1000.35.out $ natsort -t r *.out -F 900 1100 # Select only numbers NOT between 900-1100 mode744.43.out mode1243.34.out @@ -144,4 +144,3 @@ If you are sorting paths with OS-generated filenames, you may require the ./folder (1)/file.txt ./folder (2)/file.txt ./folder (10)/file.txt - diff --git a/docs/source/versorted.rst b/docs/source/versorted.rst index 6f885976..d899ab09 100644 --- a/docs/source/versorted.rst +++ b/docs/source/versorted.rst @@ -5,4 +5,3 @@ ========================== .. autofunction:: versorted - diff --git a/setup.cfg b/setup.cfg index c16d9be3..57bd4fa7 100644 --- a/setup.cfg +++ b/setup.cfg @@ -12,7 +12,7 @@ description = Simple yet flexible natural sorting in Python. long_description = file: README.rst license = MIT license_file = LICENSE -classifiers = +classifiers = Development Status :: 5 - Production/Stable Intended Audience :: Developers Intended Audience :: Science/Research @@ -55,7 +55,7 @@ max-line-length = 89 import-order-style = pycharm doctests = True max-complexity = 10 -exclude = +exclude = natsort.egg-info, .tox, .cache, @@ -66,4 +66,3 @@ exclude = docs, .venv, natsort/compat/py23.py -