Added documentations (TheAlgorithms#11352)

* Added documentations * Update data_structures/queue/circular_queue.py --------- Co-authored-by: Christian Clauss <[email protected]>
ySergi · Apr 8, 2024 · 9e55c9d · 9e55c9d
1 parent cc2f5b1
commit 9e55c9d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/data_structures/queue/circular_queue.py b/data_structures/queue/circular_queue.py
@@ -25,6 +25,7 @@ def __len__(self) -> int:
 
     def is_empty(self) -> bool:
         """
+        Checks whether the queue is empty or not
         >>> cq = CircularQueue(5)
         >>> cq.is_empty()
         True
@@ -35,6 +36,7 @@ def is_empty(self) -> bool:
 
     def first(self):
         """
+        Returns the first element of the queue
         >>> cq = CircularQueue(5)
         >>> cq.first()
         False
@@ -45,7 +47,8 @@ def first(self):
 
     def enqueue(self, data):
         """
-        This function insert an element in the queue using self.rear value as an index
+        This function inserts an element at the end of the queue using self.rear value
+        as an index.
         >>> cq = CircularQueue(5)
         >>> cq.enqueue("A")  # doctest: +ELLIPSIS
         <data_structures.queue.circular_queue.CircularQueue object at ...
@@ -67,7 +70,7 @@ def enqueue(self, data):
     def dequeue(self):
         """
         This function removes an element from the queue using on self.front value as an
-        index
+        index and returns it
         >>> cq = CircularQueue(5)
         >>> cq.dequeue()
         Traceback (most recent call last):

diff --git a/data_structures/queue/circular_queue_linked_list.py b/data_structures/queue/circular_queue_linked_list.py
@@ -39,7 +39,7 @@ def create_linked_list(self, initial_capacity: int) -> None:
 
     def is_empty(self) -> bool:
         """
-        Checks where the queue is empty or not
+        Checks whether the queue is empty or not
         >>> cq = CircularQueueLinkedList()
         >>> cq.is_empty()
         True