refactor: format, lint, and improve docstrings

leandcesar · Jan 6, 2023 · 88857a2 · 88857a2
1 parent f3fe5e3
commit 88857a2
Show file tree

Hide file tree

Showing 75 changed files with 1,493 additions and 1,809 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -2,6 +2,14 @@
 History
 =======
 
+0.2.0 (2023-01-06)
+------------------
+
+* Format and lint.
+* Remove utils.
+* Improve docstrings.
+
+
 0.1.0 (2022-12-25)
 ------------------
 

diff --git a/Makefile b/Makefile
@@ -51,8 +51,10 @@ lint/flake8: ## check style with flake8
 	flake8 wa_me tests
 lint/black: ## check style with black
 	black --check wa_me tests
+lint/interrogate: ## check docstring with interrogate
+	interrogate wa_me tests
 
-lint: lint/flake8 lint/black ## check style
+lint: lint/flake8 lint/black lint/interrogate ## check style and doctring
 
 test: ## run tests quickly with the default Python
 	pytest

diff --git a/README.rst b/README.rst
@@ -23,12 +23,14 @@ Features
 --------
 
 * Full `Send Messages`_ Support:
+
   * text
   * media (audio, documents, images, sticker, and videos)
   * contacts
   * interactive (buttons, list, and products)
   * location
   * templates
+
 * Full `Webhook Notification`_ Parsing Support
 
 Installing

diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/history.doctree b/docs/_build/doctrees/history.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/readme.doctree b/docs/_build/doctrees/readme.doctree
diff --git a/docs/_build/doctrees/wa_me.classes.doctree b/docs/_build/doctrees/wa_me.classes.doctree
diff --git a/docs/_build/doctrees/wa_me.core.doctree b/docs/_build/doctrees/wa_me.core.doctree
diff --git a/docs/_build/doctrees/wa_me.doctree b/docs/_build/doctrees/wa_me.doctree
diff --git a/docs/_build/doctrees/wa_me.utils.doctree b/docs/_build/doctrees/wa_me.utils.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 1cb938c2c698f68a31c660d9893c8d5f
+config: c7d3e2a7018124289c37902a1fd66be2
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; wa_me 0.1.0 documentation</title>
+    <title>Overview: module code &#8212; wa_me 0.2.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
     <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
@@ -40,11 +40,9 @@ <h1>All modules for which code is available</h1>
 <li><a href="wa_me/classes/responses.html">wa_me.classes.responses</a></li>
 <li><a href="wa_me/context.html">wa_me.context</a></li>
 <li><a href="wa_me/core/client.html">wa_me.core.client</a></li>
+<li><a href="wa_me/core/converter.html">wa_me.core.converter</a></li>
 <li><a href="wa_me/core/errors.html">wa_me.core.errors</a></li>
 <li><a href="wa_me/core/http.html">wa_me.core.http</a></li>
-<li><a href="wa_me/utils/converter.html">wa_me.utils.converter</a></li>
-<li><a href="wa_me/utils/routine.html">wa_me.utils.routine</a></li>
-<li><a href="wa_me/utils/ttl_dict.html">wa_me.utils.ttl_dict</a></li>
 </ul>
 
           </div>
@@ -63,7 +61,6 @@ <h1 class="logo"><a href="../index.html">wa_me</a></h1>
 
 
 <h3>Navigation</h3>
-<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../readme.html">WhatsApp Messenger</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../modules.html">wa_me</a></li>

diff --git a/docs/_build/html/_modules/wa_me/bot.html b/docs/_build/html/_modules/wa_me/bot.html
diff --git a/docs/_build/html/_modules/wa_me/classes/enums.html b/docs/_build/html/_modules/wa_me/classes/enums.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>wa_me.classes.enums &#8212; wa_me 0.1.0 documentation</title>
+    <title>wa_me.classes.enums &#8212; wa_me 0.2.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css" />
     <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
@@ -137,16 +137,15 @@ <h1>Source code for wa_me.classes.enums</h1><div class="highlight"><pre>
 
 <span class="sd">        Indicates where a conversation has started.</span>
 
-<span class="sd">        - &quot;business_initiated&quot;: Indicates that the conversation started by a business</span>
-<span class="sd">        sending the first message to a customer. This applies any time it has been</span>
-<span class="sd">        more than 24 hours since the last customer message.</span>
-
-<span class="sd">        - &quot;customer_initiated&quot;: Indicates that the conversation started by a business</span>
-<span class="sd">        replying to a customer message. This applies only when the business reply is</span>
-<span class="sd">        within 24 hours of the last customer message.</span>
-
-<span class="sd">        - &quot;referral_conversion&quot;: Indicates that the conversation originated from</span>
-<span class="sd">        a free entry point. These conversations are always customer-initiated.</span>
+<span class="sd">        - `business_initiated`: Indicates that the conversation started by a</span>
+<span class="sd">        business sending the first message to a customer. This applies any</span>
+<span class="sd">        time it has been more than 24 hours since the last customer message.</span>
+<span class="sd">        - `customer_initiated`: Indicates that the conversation started by a</span>
+<span class="sd">        business replying to a customer message. This applies only when the</span>
+<span class="sd">        business reply is within 24 hours of the last customer message.</span>
+<span class="sd">        - `referral_conversion`: Indicates that the conversation originated</span>
+<span class="sd">        from a free entry point. These conversations are always</span>
+<span class="sd">        customer-initiated.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="n">business_initiated</span> <span class="o">=</span> <span class="s2">&quot;business_initiated&quot;</span>
@@ -221,7 +220,6 @@ <h1 class="logo"><a href="../../../index.html">wa_me</a></h1>
 
 
 <h3>Navigation</h3>
-<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../readme.html">WhatsApp Messenger</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../modules.html">wa_me</a></li>