Rename Warning sections in docs to Warnings.

salt-die · Mar 17, 2024 · ba95e37 · ba95e37
1 parent c085746
commit ba95e37
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/src/batgrl/gadgets/text_effects/__init__.py b/src/batgrl/gadgets/text_effects/__init__.py
@@ -7,8 +7,8 @@
 ----------
 https://github.com/ChrisBuilds/terminaltexteffects
 
-Warning
--------
+Warnings
+--------
 Modifying the text size while effect is running will break the effect.
 """
 from .beams import beams_effect

diff --git a/src/batgrl/gadgets/text_effects/beams.py b/src/batgrl/gadgets/text_effects/beams.py
@@ -27,8 +27,8 @@ async def beams_effect(text: Text):
     text : Text
         The text gadget which to run the effect.
 
-    Warning
-    -------
+    Warnings
+    --------
     Modifying `text` size while effect is running will break the effect.
     """
     cover = Text(size=text.size)

diff --git a/src/batgrl/gadgets/text_effects/black_hole.py b/src/batgrl/gadgets/text_effects/black_hole.py
@@ -37,8 +37,8 @@ async def black_hole_effect(text: Text):
     text : Text
         The text gadget which to run the effect.
 
-    Warning
-    -------
+    Warnings
+    --------
     Modifying `text` size while effect is running will break the effect.
     """
     pos, cells = particle_data_from_canvas(text.canvas)

diff --git a/src/batgrl/gadgets/text_effects/ring.py b/src/batgrl/gadgets/text_effects/ring.py
@@ -26,8 +26,8 @@ async def ring_effect(text: Text):
     text : Text
         The text gadget which to run the effect.
 
-    Warning
-    -------
+    Warnings
+    --------
     Modifying `text` size while effect is running will break the effect.
     """
     pos, cells = particle_data_from_canvas(text.canvas)

diff --git a/src/batgrl/gadgets/text_effects/spotlights.py b/src/batgrl/gadgets/text_effects/spotlights.py
@@ -28,8 +28,8 @@ async def spotlights_effect(text: Text):
     text : Text
         The text gadget which to run the effect.
 
-    Warning
-    -------
+    Warnings
+    --------
     Modifying `text` size while effect is running will break the effect.
     """
     cover = Text(size=text.size)