diff options
author | Seth Morton <seth.m.morton@gmail.com> | 2022-01-30 14:33:13 -0800 |
---|---|---|
committer | Seth Morton <seth.m.morton@gmail.com> | 2022-01-30 14:33:13 -0800 |
commit | dd20f98cb2e686ff8817108bd24f2df2b670faef (patch) | |
tree | 0589b386ec0223eea6b2da6685f11dfd323b4c9c /docs/howitworks.rst | |
parent | f311559453cb09d603ddd6b59f16e4544575508b (diff) | |
download | natsort-dd20f98cb2e686ff8817108bd24f2df2b670faef.tar.gz |
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.
Diffstat (limited to 'docs/howitworks.rst')
-rw-r--r-- | docs/howitworks.rst | 7 |
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 +++++++++++++++++++++++++ |