Fix/docstrings

doc/Makefile

@@ -5,7 +5,7 @@
 # make target
 
 # Use uv (if it is installed) to run all python related commands,
-# and prefere the active environment over .venv in a parent folder
+# and prefer the active environment over .venv in a parent folder
 ifeq ($(OS),Windows_NT)
   HAS_UV := $(if $(shell where uv 2>NUL),true,false)
 else

plotnine/_mpl/text.py

@@ -86,8 +86,8 @@ def _line_height(self, renderer) -> float:
                 PlotnineWarning,
             )
         else:
-            # The the text has multiple lines, we use the maximum height
-            # of anyone single line.
+            # If the text has multiple lines, use the maximum height
+            # of any single line.
             height = max([p[1][1] for p in parts])
 
         return height

plotnine/iapi.py

@@ -269,7 +269,7 @@ def is_bottom(self) -> bool:
 @dataclass
 class strip_label_details:
     """
-    Strip Label Details
+    Strip label details
     """
 
     # facet variable: label for the value

plotnine/labels.py

@@ -92,14 +92,14 @@ class labs:
 
     footer: str | None = None
     """
-    The footer at the bottom of the plot
+    The footer at the bottom of the plot.
 
-    The footer when added is below the caption
+    The footer when added is below the caption.
     """
 
     tag: str | None = None
     """
-    A plot tag
+    Tag for the plot.
     """
 
     def __post_init__(self):
@@ -120,7 +120,7 @@ def __radd__(self, other: p9.ggplot) -> p9.ggplot:
 
 class xlab(labs):
     """
-    Label/name for the x aesthetic
+    Label/Name for the x aesthetic.
 
     Parameters
     ----------
@@ -134,7 +134,7 @@ def __init__(self, label: str):
 
 class ylab(labs):
     """
-    Label/name for the y aesthetic
+    Label/Name for the y aesthetic.
 
     Parameters
     ----------

plotnine/scales/scale.py

@@ -179,7 +179,7 @@ def train(self, x: pd.Series | NDArray):
 
     def dimension(self, expand=None, limits=None):
         """
-        Get the phyical size of the scale.
+        Get the physical size of the scale.
         """
         raise NotImplementedError
 

plotnine/scales/scale_continuous.py

@@ -287,7 +287,7 @@ def is_log_scale(self) -> bool:
 
     def dimension(self, expand=(0, 0, 0, 0), limits=None):
         """
-        Get the phyical size of the scale
+        Get the physical size of the scale
 
         Unlike limits, this always returns a numeric vector of length 2
         """
@@ -385,7 +385,7 @@ def to_num(x) -> float:
 
     def palette(self, x):
         """
-        Map an data values to values of the scale
+        Map data values to values of the scale
         """
         return identity_pal()(x)
 

plotnine/scales/scale_discrete.py

@@ -106,7 +106,7 @@ def train(self, x: AnyArrayLike, drop=False):
 
     def dimension(self, expand=(0, 0, 0, 0), limits=None):
         """
-        Get the phyical size of the scale
+        Get the physical size of the scale
 
         Unlike limits, this always returns a numeric vector of length 2
         """