Skip to content

Commit 4688182

Browse files
authored
Updated documentation (#570)
1 parent ff02d10 commit 4688182

File tree

4 files changed

+12
-15
lines changed

4 files changed

+12
-15
lines changed

docs/source/authors.rst

+2
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,5 @@ Harsheet <[email protected]>
2727
Pratik Goyal <[email protected]>
2828

2929
Jay Thorat <[email protected]>
30+
31+
Kishan Ved <[email protected]>

pydatastructs/linear_data_structures/arrays.py

+2-3
Original file line numberDiff line numberDiff line change
@@ -441,9 +441,8 @@ class ArrayForTrees(DynamicOneDimensionalArray):
441441
==========
442442
443443
backend: pydatastructs.Backend
444-
The backend to be used.
445-
Optional, by default, the best available
446-
backend is used.
444+
The backend to be used. Available backends: Python and C++
445+
Optional, by default, the Python backend is used. For faster execution, use the C++ backend.
447446
448447
See Also
449448
========

pydatastructs/trees/binary_trees.py

+6-9
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,8 @@ class BinaryTree(object):
4444
Set it to True, if you want to use the
4545
order statistic features of the tree.
4646
backend: pydatastructs.Backend
47-
The backend to be used.
48-
Optional, by default, the best available
49-
backend is used.
47+
The backend to be used. Available backends: Python and C++
48+
Optional, by default, the Python backend is used. For faster execution, use the C++ backend.
5049
5150
References
5251
==========
@@ -1573,9 +1572,8 @@ class BinaryTreeTraversal(object):
15731572
The binary tree for whose traversal
15741573
is to be done.
15751574
backend: pydatastructs.Backend
1576-
The backend to be used.
1577-
Optional, by default, the best available
1578-
backend is used.
1575+
The backend to be used. Available backends: Python and C++
1576+
Optional, by default, the Python backend is used. For faster execution, use the C++ backend.
15791577
15801578
Traversals
15811579
==========
@@ -1775,9 +1773,8 @@ class BinaryIndexedTree(object):
17751773
The array whose elements are to be
17761774
considered for the queries.
17771775
backend: pydatastructs.Backend
1778-
The backend to be used.
1779-
Optional, by default, the best available
1780-
backend is used.
1776+
The backend to be used. Available backends: Python and C++
1777+
Optional, by default, the Python backend is used. For faster execution, use the C++ backend.
17811778
17821779
Examples
17831780
========

pydatastructs/utils/misc_util.py

+2-3
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,8 @@ class TreeNode(Node):
6060
right: int
6161
Optional, index of the right child node.
6262
backend: pydatastructs.Backend
63-
The backend to be used.
64-
Optional, by default, the best available
65-
backend is used.
63+
The backend to be used. Available backends: Python and C++
64+
Optional, by default, the Python backend is used. For faster execution, use the C++ backend.
6665
"""
6766

6867
__slots__ = ['key', 'data', 'left', 'right', 'is_root',

0 commit comments

Comments
 (0)