Apply suggestions from code review

Co-authored-by: David Brochart <[email protected]>
jupyter-server · Oct 3, 2024 · c1b0496 · c1b0496
1 parent 3aa8387
commit c1b0496
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 6 deletions.
diff --git a/jupyter_ydoc/ybasedoc.py b/jupyter_ydoc/ybasedoc.py
@@ -26,12 +26,14 @@ def __init__(self, ydoc: Optional[Doc] = None, awareness: Optional[Awareness] =
 
         :param ydoc: The :class:`pycrdt.Doc` that will hold the data of the document, if provided.
         :type ydoc: :class:`pycrdt.Doc`, optional.
+        :param awareness: The :class:`pycrdt.Awareness` that share non persistent data
+                          between clients.
+        :type awareness: :class:`pycrdt.Awareness`, optional.
         """
         if ydoc is None:
             self._ydoc = Doc()
         else:
             self._ydoc = ydoc
-
         self._awareness = awareness
 
         self._ystate = self._ydoc.get("state", type=Map)
@@ -80,19 +82,20 @@ def ydoc(self) -> Doc:
     @property
     def awareness(self) -> Awareness | None:
         """
-        Return the awareness.
+        Returns the awareness.
 
         :return: The document's awareness.
-        :rtype: :class:`pycrdt_websocket.awareness.Awareness`
+        :rtype: :class:`pycrdt.Awareness` or None.
         """
         return self._awareness
 
     @awareness.setter
-    def awareness(self, value: Awareness):
+    def awareness(self, value: Awareness) -> None:
         """
         Sets the awareness.
 
-        :param: The awareness.
+        :param value: The awareness to set.
+        :type value: :class:`pycrdt.Awareness`.
         """
         self._awareness = value
 

diff --git a/jupyter_ydoc/yblob.py b/jupyter_ydoc/yblob.py
@@ -30,6 +30,9 @@ def __init__(self, ydoc: Optional[Doc] = None, awareness: Optional[Awareness] =
 
         :param ydoc: The :class:`pycrdt.Doc` that will hold the data of the document, if provided.
         :type ydoc: :class:`pycrdt.Doc`, optional.
+        :param awareness: The :class:`pycrdt.Awareness` that share non persistent data
+                          between clients.
+        :type awareness: :class:`pycrdt.Awareness`, optional.
         """
         super().__init__(ydoc, awareness)
         self._ysource = self._ydoc.get("source", type=Map)

diff --git a/jupyter_ydoc/ynotebook.py b/jupyter_ydoc/ynotebook.py
@@ -53,6 +53,9 @@ def __init__(self, ydoc: Optional[Doc] = None, awareness: Optional[Awareness] =
 
         :param ydoc: The :class:`pycrdt.Doc` that will hold the data of the document, if provided.
         :type ydoc: :class:`pycrdt.Doc`, optional.
+        :param awareness: The :class:`pycrdt.Awareness` that share non persistent data
+                          between clients.
+        :type awareness: :class:`pycrdt.Awareness`, optional.
         """
         super().__init__(ydoc, awareness)
         self._ymeta = self._ydoc.get("meta", type=Map)

diff --git a/jupyter_ydoc/yunicode.py b/jupyter_ydoc/yunicode.py
@@ -29,6 +29,9 @@ def __init__(self, ydoc: Optional[Doc] = None, awareness: Optional[Awareness] =
 
         :param ydoc: The :class:`pycrdt.Doc` that will hold the data of the document, if provided.
         :type ydoc: :class:`pycrdt.Doc`, optional.
+        :param awareness: The :class:`pycrdt.Awareness` that share non persistent data
+                          between clients.
+        :type awareness: :class:`pycrdt.Awareness`, optional.
         """
         super().__init__(ydoc, awareness)
         self._ysource = self._ydoc.get("source", type=Text)

diff --git a/pyproject.toml b/pyproject.toml
@@ -28,7 +28,7 @@ dev = [
 ]
 test = [
     "pre-commit",
-    "pytest >=9.16",
+    "pytest",
     "pytest-asyncio",
     "websockets >=10.0",
     "pycrdt-websocket >=0.14.1,<0.15.0",