From dd20f98cb2e686ff8817108bd24f2df2b670faef Mon Sep 17 00:00:00 2001 From: Seth Morton Date: Sun, 30 Jan 2022 14:33:13 -0800 Subject: Add a note in How-it-works about path suffix splitting Basically, I just point out that the example is more simple than the real thing. --- docs/howitworks.rst | 7 +++++++ 1 file changed, 7 insertions(+) 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 +++++++++++++++++++++++++ -- cgit v1.2.1