From 9e55c9d9845c07ce6390ab92a2d86be4816d4a69 Mon Sep 17 00:00:00 2001
From: Jiayou Qin <90779499+Jiayoqin@users.noreply.github.com>
Date: Mon, 8 Apr 2024 07:35:22 -0400
Subject: [PATCH] Added documentations (#11352)

* Added documentations

* Update data_structures/queue/circular_queue.py

---------

Co-authored-by: Christian Clauss <cclauss@me.com>
---
 data_structures/queue/circular_queue.py             | 7 +++++--
 data_structures/queue/circular_queue_linked_list.py | 2 +-
 2 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/data_structures/queue/circular_queue.py b/data_structures/queue/circular_queue.py
index 93a6ef805..f2fb4c01e 100644
--- a/data_structures/queue/circular_queue.py
+++ b/data_structures/queue/circular_queue.py
@@ -25,6 +25,7 @@ class CircularQueue:
 
     def is_empty(self) -> bool:
         """
+        Checks whether the queue is empty or not
         >>> cq = CircularQueue(5)
         >>> cq.is_empty()
         True
@@ -35,6 +36,7 @@ class CircularQueue:
 
     def first(self):
         """
+        Returns the first element of the queue
         >>> cq = CircularQueue(5)
         >>> cq.first()
         False
@@ -45,7 +47,8 @@ class CircularQueue:
 
     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 @@ class CircularQueue:
     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 62042c4bc..da8629678 100644
--- a/data_structures/queue/circular_queue_linked_list.py
+++ b/data_structures/queue/circular_queue_linked_list.py
@@ -39,7 +39,7 @@ class CircularQueueLinkedList:
 
     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