From d81cab91cba3be497aa5e0dcb867b940ebf0bfe4 Mon Sep 17 00:00:00 2001 From: x0Lazarus <113273587+x0Lazarus@users.noreply.github.com> Date: Fri, 18 Sep 2026 10:39:27 -0700 Subject: [PATCH] docs: describe criteria for feature requests --- README.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.rst b/README.rst index c72c5e9..bdae063 100644 --- a/README.rst +++ b/README.rst @@ -32,6 +32,7 @@ Simple yet flexible natural sorting in Python. - `Quick Description`_ - `Quick Examples`_ - `FAQ`_ + - `Feature Requests`_ - `Requirements`_ - `Optional Dependencies`_ - `Installation`_ @@ -352,6 +353,20 @@ How *does* `natsort`_ work? Because a `tuple`_ is always returned, a `TypeError`_ should not be common unless one tries to do something odd like sort an `int`_ against a `list`_. +Feature Requests +---------------- + +In general, feature requests must meet all of the following criteria to be +considered for implementation in `natsort`_: + +- The correct behavior must be obvious: people with different backgrounds + would all agree that the proposed behavior is correct. +- The feature cannot be implemented with a simple and obvious one-liner + using the ``key`` argument. +- The feature will not result in infinite churn. + +See `Further Customizing Natsort`_ for examples of using the ``key`` argument. + Shell script ------------