diff options
author | W. Trevor King <wking@tremily.us> | 2012-10-26 08:41:21 -0400 |
---|---|---|
committer | W. Trevor King <wking@tremily.us> | 2012-10-26 08:41:21 -0400 |
commit | 3354bfda0d54f860f7c83db76dd32e395cd5d1ee (patch) | |
tree | 25ebeb99d9ed8ca69dcc3d6ce93968a50a290600 /libbe/util/tree.py | |
parent | 27ca8426ae587b73cde11a5d681efc029b8632a4 (diff) | |
download | bugseverywhere-3354bfda0d54f860f7c83db76dd32e395cd5d1ee.tar.gz |
doc: update :meth: to :py:meth: for modern Sphinx.
Diffstat (limited to 'libbe/util/tree.py')
-rw-r--r-- | libbe/util/tree.py | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/libbe/util/tree.py b/libbe/util/tree.py index affdb85..c6aa46b 100644 --- a/libbe/util/tree.py +++ b/libbe/util/tree.py @@ -149,13 +149,13 @@ class Tree(list): def sort(self, *args, **kwargs): """Sort the tree recursively. - This method extends :meth:`list.sort` to Trees. + This method extends :py:meth:`list.sort` to Trees. Notes ----- - This method can be slow, e.g. on a :meth:`branch_len` sort, + This method can be slow, e.g. on a :py:meth:`branch_len` sort, since a node at depth `N` from the root has it's - :meth:`branch_len` method called `N` times. + :py:meth:`branch_len` method called `N` times. """ list.sort(self, *args, **kwargs) for child in self: @@ -170,7 +170,7 @@ class Tree(list): Depth first by default, but you can set `depth_first` to `False` for breadth first ordering. Siblings are returned in the order they are stored, so you might want to - :meth:`sort` your tree first. + :py:meth:`sort` your tree first. """ if depth_first == True: yield self @@ -202,7 +202,7 @@ class Tree(list): a-+-c and a-+ +-d-e-f +-d-e-f - would both produce (after sorting by :meth:`branch_len`):: + would both produce (after sorting by :py:meth:`branch_len`):: (0, a) (1, b) |