Skip to content

Commit c89892c

Browse files
committed
Move the new Sort section under Modules
1 parent 0b852dc commit c89892c

File tree

2 files changed

+23
-20
lines changed

2 files changed

+23
-20
lines changed

docs/features.rst

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -324,26 +324,6 @@ instead of deleting it completely. To do so, one can set the directive::
324324
By default all leaves have it set to ``true`` (such node is selected)
325325
and branches have set it to ``false`` (such node is not selected).
326326

327-
.. _sort:
328-
329-
Sort
330-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
331-
332-
By default, when exploring test metadata in the tree, child nodes
333-
are sorted alphabetically by node name. This applies to command
334-
line usage such as ``fmf ls`` or ``fmf show`` as well as for the
335-
:py:meth:`fmf.Tree.climb()` and :py:meth:`fmf.Tree.prune()`
336-
methods.
337-
338-
If the tree content is not created from files on disk but created
339-
manually using the :py:meth:`fmf.Tree.child()` method, the child
340-
order can be preserved by providing the ``sort=False`` parameter
341-
to the :py:meth:`fmf.Tree.climb()` and :py:meth:`fmf.Tree.prune()`
342-
methods.
343-
344-
.. versionadded:: 1.6
345-
346-
347327
.. _virtual:
348328

349329
Virtual

docs/modules.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,29 @@
33
Modules
44
===============
55

6+
.. _sort:
7+
8+
Sort
9+
----
10+
11+
By default, when exploring test metadata in the tree, child nodes
12+
are sorted alphabetically by node name. This applies to command
13+
line usage such as ``fmf ls`` or ``fmf show`` as well as for the
14+
:py:meth:`fmf.Tree.climb()` and :py:meth:`fmf.Tree.prune()`
15+
methods.
16+
17+
If the tree content is not created from files on disk but created
18+
manually using the :py:meth:`fmf.Tree.child()` method, the child
19+
order can be preserved by providing the ``sort=False`` parameter
20+
to the :py:meth:`fmf.Tree.climb()` and :py:meth:`fmf.Tree.prune()`
21+
methods.
22+
23+
.. versionadded:: 1.6
24+
25+
26+
fmf
27+
---
28+
629
.. automodule:: fmf
730
:members:
831
:undoc-members:

0 commit comments

Comments
 (0)