summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/howitworks.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/howitworks.rst b/docs/howitworks.rst
index 0a6eebc..45b47a4 100644
--- a/docs/howitworks.rst
+++ b/docs/howitworks.rst
@@ -413,6 +413,13 @@ is done, we can see how comparisons can be done in the expected manner.
>>> a > b
True
+.. note::
+
+ The actual :meth:`decompose_path_into_components`-equivalent function in
+ :mod:`natsort` actually has a few more heuristics than shown here so that
+ it is not over-zealous in what it defines as a path suffix, but this has
+ been omitted in this how-to for clarity.
+
Comparing Different Types
+++++++++++++++++++++++++