release: v1.6.4 (#191)

* chore: update version strings

* docs: update requirements list

docs/source/conf.py

@@ -9,7 +9,7 @@
 project = 'docformatter'
 copyright = '2022-2023, Steven Myint'
 author = 'Steven Myint'
-release = '1.6.3'
+release = '1.6.4'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/requirements.rst

@@ -153,15 +153,17 @@ the requirement falls in, the type of requirement, and whether
 
     ' PEP_257_1','Always use """triple double quotes"""',' Convention',' Shall',' Yes'
     ' PEP_257_2','Use r"""raw triple double quotes""" if you use backslashes.',' Convention',' Shall',' Yes'
-    ' PEP_257_3','Use u"""unicode triple double quotes""" for unicode  docstrings.',' Convention',' Shall',' Yes'
+    ' PEP_257_3','Use u"""unicode triple double quotes""" for unicode docstrings.',' Convention',' Shall',' Yes'
     ' PEP_257_4','**One-line docstrings:**'
     ' PEP_257_4.1',' Should fit on a single line.',' Convention',' Should',' Yes'
     ' PEP_257_4.2',' Use triple quotes.',' Convention',' Shall',' Yes'
     ' PEP_257_4.3',' Closing quotes are on the same line as opening quotes.',' Convention',' Shall',' Yes'
     ' PEP_257_4.4',' No blank line before or after the docstring.',' Convention',' Shall',' Yes'
     ' PEP_257_4.5',' Is a phrase ending in a period.',' Convention',' Shall',' Yes'
     ' docformatter_4.5.1', ' One-line docstrings may end in any of the following punctuation marks [. ! ?]', ' Derived', ' May', ' Yes'
-    ' docformatter_4.5.1', ' One-line docstrings will have the first word capitalized.', ' Derived', ' Shall', ' No'
+    ' docformatter_4.5.2', ' One-line docstrings will have the first word capitalized.', ' Derived', ' Shall', ' Yes'
+    ' docformatter_4.5.2.1', ' First words in one-line docstrings that are variables or filenames shall remain unchanged.', ' Derived', ' Shall', ' Yes [PR #185, #188]'
+    ' docformatter_4.5.3', ' Shall not place a newline after the first line of a wrapped one-line docstring.' ' Derived', ' Shall', ' Yes [PR #179]'
     ' PEP_257_5','**Multi-line docstrings:**'
     ' PEP_257_5.1',' A summary is just like a one-line docstring.',' Convention',' Shall',' Yes'
     ' docformatter_5.1.1', ' The summary line shall satisfy all the requirements of a one-line docstring.', ' Derived', ' Shall', ' Yes'
@@ -196,6 +198,7 @@ the requirement falls in, the type of requirement, and whether
     ' docformatter_10.1.2', ' Should allow/disallow wrapping of one-line docstrings.', ' Derived', ' Should', ' No'
     ' docformatter_10.1.3', ' Shall not wrap links that exceed the wrap length.', ' Derived', ' Shall', ' Yes [*PR #114*]'
     ' docformatter_10.1.3.1', ' Shall maintain in-line links on one line even if the resulting line exceeds wrap length.', ' Derived', ' Shall', ' Yes [*PR #152*]'
+    ' docformatter_10.1.3.2', ' Shall not place a newline between description text and a wrapped link.', ' Derived', ' Shall', ' Yes [PR #182]'
     ' docformatter_10.2', ' Should format docstrings using NumPy style.', ' Style', ' Should', ' No'
     ' docformatter_10.3', ' Should format docstrings using Google style.', ' Style', ' Should', ' No'
     ' docformatter_10.4', ' Should format docstrings using Sphinx style.',' Style', ' Should', ' No'

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "docformatter"
-version = "1.6.3"
+version = "1.6.4"
 description = "Formats docstrings to follow PEP 257"
 authors = ["Steven Myint"]
 maintainers = [
@@ -220,6 +220,7 @@ commands =
         --cov=docformatter \
         --cov-config={toxinidir}/pyproject.toml \
         --cov-branch \
+        --cov-append \
         {toxinidir}/tests/
 
 [testenv:coverage]

src/docformatter/__pkginfo__.py

@@ -23,4 +23,4 @@
 # SOFTWARE.
 """Package information for docformatter."""
 
-__version__ = "1.6.3"
+__version__ = "1.6.4"