Documentation update (#29)

* Add human-readable colours (#18) * Add human-readable colours to output * Update test to work with human-readable colors * Add webcolors dependency Co-authored-by: MarvinKweyu <mkweyu1@gmail.com> Co-authored-by: Clifford Onyonka <jsjamessakho@gmail.com> * docs: update ColorDetect method documentation for human readability * style: code linting * chore: update release docs Co-authored-by: Clifford Onyonka <jsjamessakho@gmail.com>
MarvinKweyu · Feb 2, 2021 · c0077e0 · c0077e0
1 parent 1689200
commit c0077e0
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 5 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -2,6 +2,21 @@
 ColorDetect Changelog
 =====================
 
+
+.. _1.3.0:
+1.3.0 (02-02-2021)
+====================
+
+Features
+--------
+
+- Add a return of human readable colors.
+
+Documentation
+-------------
+
+- Update ColorDetect module documentation to show method params
+
 .. _1.3.0rc:
 1.3.0rc (18-01-2021)
 ====================

diff --git a/colordetect/color_detect.py b/colordetect/color_detect.py
@@ -47,9 +47,7 @@ def __init__(self, image):
 
         self.color_description = {}
 
-    def get_color_count(
-        self, color_count: int = 5, color_format: str = "human_readable"
-    ) -> dict:
+    def get_color_count(self, color_count: int = 5, color_format: str = "human_readable") -> dict:
         """
         .. _get_color_count:
         get_color_count

diff --git a/docs/conf.py b/docs/conf.py
@@ -24,7 +24,7 @@
 author = "Marvin Kweyu"
 
 # The full version, including alpha/beta/rc tags
-release = "1.3.0rc"
+release = "1.3.0"
 
 # -- General configuration ---------------------------------------------------
 

diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="ColorDetect",
-    version="1.3.0rc",
+    version="1.3.0",
     author="Marvin Kweyu",
     author_email="mkweyu1@gmail.com",
     description="Detect and recognize colors in images or video",