Skip to content

Commit

Permalink
Updated documentation (#570)
Browse files Browse the repository at this point in the history
  • Loading branch information
Kishan-Ved authored Aug 1, 2024
1 parent ff02d10 commit 4688182
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 15 deletions.
2 changes: 2 additions & 0 deletions docs/source/authors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,5 @@ Harsheet <harsheetkakar@gmail.com>
Pratik Goyal <pratikgoyal2712@gmail.com>

Jay Thorat <j.thorat10@gmail.com>

Kishan Ved <kishanved123456@gmail.com>
5 changes: 2 additions & 3 deletions pydatastructs/linear_data_structures/arrays.py
Original file line number Diff line number Diff line change
Expand Up @@ -441,9 +441,8 @@ class ArrayForTrees(DynamicOneDimensionalArray):
==========
backend: pydatastructs.Backend
The backend to be used.
Optional, by default, the best available
backend is used.
The backend to be used. Available backends: Python and C++
Optional, by default, the Python backend is used. For faster execution, use the C++ backend.
See Also
========
Expand Down
15 changes: 6 additions & 9 deletions pydatastructs/trees/binary_trees.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,8 @@ class BinaryTree(object):
Set it to True, if you want to use the
order statistic features of the tree.
backend: pydatastructs.Backend
The backend to be used.
Optional, by default, the best available
backend is used.
The backend to be used. Available backends: Python and C++
Optional, by default, the Python backend is used. For faster execution, use the C++ backend.
References
==========
Expand Down Expand Up @@ -1573,9 +1572,8 @@ class BinaryTreeTraversal(object):
The binary tree for whose traversal
is to be done.
backend: pydatastructs.Backend
The backend to be used.
Optional, by default, the best available
backend is used.
The backend to be used. Available backends: Python and C++
Optional, by default, the Python backend is used. For faster execution, use the C++ backend.
Traversals
==========
Expand Down Expand Up @@ -1775,9 +1773,8 @@ class BinaryIndexedTree(object):
The array whose elements are to be
considered for the queries.
backend: pydatastructs.Backend
The backend to be used.
Optional, by default, the best available
backend is used.
The backend to be used. Available backends: Python and C++
Optional, by default, the Python backend is used. For faster execution, use the C++ backend.
Examples
========
Expand Down
5 changes: 2 additions & 3 deletions pydatastructs/utils/misc_util.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,8 @@ class TreeNode(Node):
right: int
Optional, index of the right child node.
backend: pydatastructs.Backend
The backend to be used.
Optional, by default, the best available
backend is used.
The backend to be used. Available backends: Python and C++
Optional, by default, the Python backend is used. For faster execution, use the C++ backend.
"""

__slots__ = ['key', 'data', 'left', 'right', 'is_root',
Expand Down

0 comments on commit 4688182

Please sign in to comment.