From 4e4fb4589a34cf0b8e5f24003d731b3957a4783a Mon Sep 17 00:00:00 2001
From: Jiayou Qin <90779499+Jiayoqin@users.noreply.github.com>
Date: Tue, 26 Mar 2024 16:00:22 +0000
Subject: [PATCH 1/2] Added documentations

---
 data_structures/queue/circular_queue.py             | 6 ++++--
 data_structures/queue/circular_queue_linked_list.py | 2 +-
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/data_structures/queue/circular_queue.py b/data_structures/queue/circular_queue.py
index 93a6ef805c7c..bb9e2734ff16 100644
--- 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,7 @@ def first(self):
 
     def enqueue(self, data):
         """
-        This function insert an element in the queue using self.rear value as an index
+        This function insert 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 +69,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
index 62042c4bce96..da8629678e52 100644
--- 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

From 295a4906ce3740d537e561ba42c3b242c6ece0e3 Mon Sep 17 00:00:00 2001
From: Christian Clauss <cclauss@me.com>
Date: Mon, 8 Apr 2024 13:20:41 +0200
Subject: [PATCH 2/2] Update data_structures/queue/circular_queue.py

---
 data_structures/queue/circular_queue.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/data_structures/queue/circular_queue.py b/data_structures/queue/circular_queue.py
index bb9e2734ff16..f2fb4c01e467 100644
--- a/data_structures/queue/circular_queue.py
+++ b/data_structures/queue/circular_queue.py
@@ -47,7 +47,8 @@ def first(self):
 
     def enqueue(self, data):
         """
-        This function insert an element at the end of 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 ...