0.1.8.1 (#21)

* Rollback module description
* Update docs
* Format requirements files
* Hotfix Release 0.1.8.1
* Updated pylint badge

README.md

@@ -5,7 +5,7 @@
 ![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability-percentage/torrua/loglan_core?logo=Code%20Climate)
 [![Pylint](https://github.com/torrua/loglan_core/actions/workflows/pylint.yml/badge.svg)](https://github.com/torrua/loglan_core/actions/workflows/pylint.yml)
 [![Pytest](https://github.com/torrua/loglan_core/actions/workflows/pytest.yml/badge.svg)](https://github.com/torrua/loglan_core/actions/workflows/pytest.yml)
-![pylint](https://img.shields.io/badge/pylint-9.96-yellow?logo=python&logoColor=white)
+![pylint](https://img.shields.io/badge/pylint-9.94-yellow?logo=python&logoColor=white)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/loglan_core?color=yellow)
 ![PyPI - Version](https://img.shields.io/pypi/v/loglan-core?logo=PyPi&logoColor=%23FFFFFF)
 ![GitHub License](https://img.shields.io/github/license/torrua/loglan_core)

docs/addons/index.html

@@ -5,7 +5,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
 <meta name="generator" content="pdoc 0.10.0" />
 <title>loglan_core.addons API documentation</title>
-<meta name="description" content="This module contains an addons for basic Models" />
+<meta name="description" content="This module contains an addons for BaseModels" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
 <link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
@@ -22,7 +22,7 @@
 <h1 class="title">Module <code>loglan_core.addons</code></h1>
 </header>
 <section id="section-intro">
-<p>This module contains an addons for basic Models</p>
+<p>This module contains an addons for BaseModels</p>
 </section>
 <section>
 <h2 class="section-title" id="header-submodules">Sub-modules</h2>

docs/index.html

@@ -29,7 +29,7 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 <dl>
 <dt><code class="name"><a title="loglan_core.addons" href="addons/index.html">loglan_core.addons</a></code></dt>
 <dd>
-<div class="desc"><p>This module contains an addons for basic Models</p></div>
+<div class="desc"><p>This module contains an addons for BaseModels</p></div>
 </dd>
 <dt><code class="name"><a title="loglan_core.author" href="author.html">loglan_core.author</a></code></dt>
 <dd>

docs/syllable.html

@@ -35,7 +35,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="loglan_core.syllable.BaseSyllable"><code class="flex name class">
 <span>class <span class="ident">BaseSyllable</span></span>
-<span>(</span><span>name, type, allowed=None)</span>
+<span>(</span><span>name, type, allowed)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Base Syllable's DB Model</p>
@@ -58,7 +58,7 @@ <h3>Instance variables</h3>
 <dt id="loglan_core.syllable.BaseSyllable.allowed"><code class="name">var <span class="ident">allowed</span> : Union[sqlalchemy.orm.attributes.InstrumentedAttribute[~_T], ~_T]</code></dt>
 <dd>
 <div class="desc"><p><em>Is this syllable acceptable in grammar</em><br>
-<strong>bool</strong> : nullable=True, unique=False</p></div>
+<strong>bool</strong> : nullable=False, unique=False</p></div>
 </dd>
 <dt id="loglan_core.syllable.BaseSyllable.name"><code class="name">var <span class="ident">name</span> : Union[sqlalchemy.orm.attributes.InstrumentedAttribute[~_T], ~_T]</code></dt>
 <dd>

loglan_core/addons/__init__.py

@@ -0,0 +1,3 @@
+"""
+This module contains an addons for BaseModels
+"""

requirements-docs.txt

@@ -1,3 +1,3 @@
 -r requirements.txt
 
-pdoc3~=0.10.0
+pdoc3~=0.10.0

requirements.txt

@@ -1 +1 @@
-SQLAlchemy>=2.0.21
+SQLAlchemy>=2.0.21

setup.py

@@ -5,7 +5,7 @@
 
 from setuptools import setup
 
-CURRENT_VERSION = "0.1.8"
+CURRENT_VERSION = "0.1.8.1"
 
 
 def read(filename):  # pylint: disable=C0116