From cdf8d79e9f02e360b14f675d36587dd94afbb915 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Sat, 6 Oct 2018 18:10:38 +1000 Subject: Help: Improve/fix incorrect docs for list(SORT) sub-options --- Help/command/list.rst | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/Help/command/list.rst b/Help/command/list.rst index ad2c428..2357a9b 100644 --- a/Help/command/list.rst +++ b/Help/command/list.rst @@ -256,20 +256,24 @@ Reverses the contents of the list in-place. list(SORT [COMPARE ] [CASE ] [ORDER ]) Sorts the list in-place alphabetically. -Use the option ```` to select the compare type for sorting. -The ```` option may be one of: +Use the ``COMPARE`` keyword to select the comparison method for sorting. +The ```` option should be one of: -* ``STRING``: Sorts a list of strings alphabetically. -* ``FILE_BASENAME``: Sort a list of pathnames of files by their basenames. +* ``STRING``: Sorts a list of strings alphabetically. This is the + default behavior if the ``COMPARE`` option is not given. +* ``FILE_BASENAME``: Sorts a list of pathnames of files by their basenames. -Use the option ```` to select a case sensitive or case insensitive sort mode. -The ```` option may be one of: +Use the ``CASE`` keyword to select a case sensitive or case insensitive +sort mode. The ```` option should be one of: -* ``SENSITIVE``: Sorts the list alphabetically. -* ``INSENSITIVE``: Sorts the list alphabetically in descending order. +* ``SENSITIVE``: List items are sorted in a case-sensitive manner. This is + the default behavior if the ``CASE`` option is not given. +* ``INSENSITIVE``: List items are sorted case insensitively. The order of + items which differ only by upper/lowercase is not specified. -Use the option ```` to select a case sensitive or case insensitive sort mode. -The ```` option may be one of: +To control the sort order, the ``ORDER`` keyword can be given. +The ```` option should be one of: -* ``ASCENDING``: Sorts the list in ascending order. +* ``ASCENDING``: Sorts the list in ascending order. This is the default + behavior when the ``ORDER`` option is not given. * ``DESCENDING``: Sorts the list in descending order. -- cgit v0.12