Add docstrings for kwargs

eylles · Nov 26, 2024 · ee2d603 · ee2d603
1 parent 07d7bf3
commit ee2d603
Show file tree

Hide file tree

Showing 9 changed files with 76 additions and 21 deletions.
diff --git a/pywal/backends/colorthief.py b/pywal/backends/colorthief.py
@@ -39,7 +39,10 @@ def gen_colors(img):
 
 
 def adjust(cols, light, **kwargs):
-    """Create palette."""
+    """Create palette.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:
@@ -54,7 +57,10 @@ def adjust(cols, light, **kwargs):
 
 
 def get(img, light=False, **kwargs):
-    """Get colorscheme."""
+    """Get colorscheme.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:

diff --git a/pywal/backends/colorz.py b/pywal/backends/colorz.py
@@ -25,7 +25,10 @@ def gen_colors(img):
 
 
 def adjust(cols, light, **kwargs):
-    """Create palette."""
+    """Create palette.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:
@@ -37,7 +40,10 @@ def adjust(cols, light, **kwargs):
 
 
 def get(img, light=False, **kwargs):
-    """Get colorscheme."""
+    """Get colorscheme.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:

diff --git a/pywal/backends/fast_colorthief.py b/pywal/backends/fast_colorthief.py
@@ -25,7 +25,10 @@ def gen_colors(img):
 
 
 def adjust(cols, light, **kwargs):
-    """Create palette."""
+    """Create palette.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:
@@ -38,7 +41,10 @@ def adjust(cols, light, **kwargs):
 
 
 def get(img, light=False, **kwargs):
-    """Get colorscheme."""
+    """Get colorscheme.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:

diff --git a/pywal/backends/haishoku.py b/pywal/backends/haishoku.py
@@ -24,7 +24,10 @@ def gen_colors(img):
 
 
 def adjust(cols, light, **kwargs):
-    """Create palette."""
+    """Create palette.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:
@@ -38,7 +41,10 @@ def adjust(cols, light, **kwargs):
 
 
 def get(img, light=False, **kwargs):
-    """Get colorscheme."""
+    """Get colorscheme.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:

diff --git a/pywal/backends/modern_colorthief.py b/pywal/backends/modern_colorthief.py
@@ -25,7 +25,10 @@ def gen_colors(img):
 
 
 def adjust(cols, light, **kwargs):
-    """Create palette."""
+    """Create palette.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:
@@ -38,7 +41,10 @@ def adjust(cols, light, **kwargs):
 
 
 def get(img, light=False, **kwargs):
-    """Get colorscheme."""
+    """Get colorscheme.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:

diff --git a/pywal/backends/okthief.py b/pywal/backends/okthief.py
@@ -26,7 +26,10 @@ def gen_colors(img):
 
 
 def adjust(cols, light, **kwargs):
-    """Create palette."""
+    """Create palette.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:
@@ -35,7 +38,10 @@ def adjust(cols, light, **kwargs):
 
 
 def get(img, light=False, **kwargs):
-    """Get colorscheme."""
+    """Get colorscheme.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:

diff --git a/pywal/backends/schemer2.py b/pywal/backends/schemer2.py
@@ -18,7 +18,10 @@ def gen_colors(img):
 
 
 def adjust(cols, light, **kwargs):
-    """Create palette."""
+    """Create palette.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:
@@ -31,7 +34,10 @@ def adjust(cols, light, **kwargs):
 
 
 def get(img, light=False, **kwargs):
-    """Get colorscheme."""
+    """Get colorscheme.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:

diff --git a/pywal/backends/wal.py b/pywal/backends/wal.py
@@ -90,7 +90,10 @@ def gen_colors(img):
 
 def adjust(cols, light, **kwargs):
     """Adjust the generated colors and store them in a dict that
-    we will later save in json format."""
+    we will later save in json format.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:
@@ -101,7 +104,10 @@ def adjust(cols, light, **kwargs):
 
 
 def get(img, light=False, **kwargs):
-    """Get colorscheme."""
+    """Get colorscheme.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
     else:

diff --git a/pywal/colors.py b/pywal/colors.py
@@ -67,10 +67,13 @@ def colors_to_dict(colors, img):
 
 def generic_adjust(colors, light, **kwargs):
     """Generic color adjustment for themers.
-    :keyword args: c16 - [ lighten | darken ]
+    :keyword-args:
+    -    c16 - [ "lighten" | "darken" ]
     """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
+    else:
+        cols16 = False
 
     if light:
         for color in colors:
@@ -273,7 +276,11 @@ def binary_luminance_adjust(
 
 
 def cache_fname(img, backend, light, cache_dir, sat="", **kwargs):
-    """Create the cache file name."""
+    """Create the cache file name.
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    -    cst: palette contrast ratio - float
+    """
     color_type = "light" if light else "dark"
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]
@@ -355,9 +362,9 @@ def get(
     **kwargs,
 ):
     """Generate a palette.
-    :keyword args:
-    c16: [ lighten | darken ] - generates a 16 color palette
-    cst: float                - applies contrast ratio to palette
+    :keyword-args:
+    -    c16: use 16 colors through specified method - [ "lighten" | "darken" ]
+    -    cst: apply contrast ratio to palette        - float
     """
     if 'c16' in kwargs:
         cols16 = kwargs["c16"]