Updated documentation (#570)

codezonediitj · Aug 1, 2024 · 4688182 · 4688182
1 parent ff02d10
commit 4688182
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 15 deletions.
diff --git a/docs/source/authors.rst b/docs/source/authors.rst
@@ -27,3 +27,5 @@ Harsheet <[email protected]>
 Pratik Goyal <[email protected]>
 
 Jay Thorat <[email protected]>
+
+Kishan Ved <[email protected]>
diff --git a/pydatastructs/linear_data_structures/arrays.py b/pydatastructs/linear_data_structures/arrays.py
@@ -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
     ========

diff --git a/pydatastructs/trees/binary_trees.py b/pydatastructs/trees/binary_trees.py
@@ -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
     ==========
@@ -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
     ==========
@@ -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
     ========

diff --git a/pydatastructs/utils/misc_util.py b/pydatastructs/utils/misc_util.py
@@ -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',