Skip to content

Commit d474559

Browse files
authored
release: v1.6.4 (#191)
* chore: update version strings * docs: update requirements list
1 parent 93ed4d7 commit d474559

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
project = 'docformatter'
1010
copyright = '2022-2023, Steven Myint'
1111
author = 'Steven Myint'
12-
release = '1.6.3'
12+
release = '1.6.4'
1313

1414
# -- General configuration ---------------------------------------------------
1515
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/requirements.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,15 +153,17 @@ the requirement falls in, the type of requirement, and whether
153153

154154
' PEP_257_1','Always use """triple double quotes"""',' Convention',' Shall',' Yes'
155155
' PEP_257_2','Use r"""raw triple double quotes""" if you use backslashes.',' Convention',' Shall',' Yes'
156-
' PEP_257_3','Use u"""unicode triple double quotes""" for unicode docstrings.',' Convention',' Shall',' Yes'
156+
' PEP_257_3','Use u"""unicode triple double quotes""" for unicode docstrings.',' Convention',' Shall',' Yes'
157157
' PEP_257_4','**One-line docstrings:**'
158158
' PEP_257_4.1',' Should fit on a single line.',' Convention',' Should',' Yes'
159159
' PEP_257_4.2',' Use triple quotes.',' Convention',' Shall',' Yes'
160160
' PEP_257_4.3',' Closing quotes are on the same line as opening quotes.',' Convention',' Shall',' Yes'
161161
' PEP_257_4.4',' No blank line before or after the docstring.',' Convention',' Shall',' Yes'
162162
' PEP_257_4.5',' Is a phrase ending in a period.',' Convention',' Shall',' Yes'
163163
' docformatter_4.5.1', ' One-line docstrings may end in any of the following punctuation marks [. ! ?]', ' Derived', ' May', ' Yes'
164-
' docformatter_4.5.1', ' One-line docstrings will have the first word capitalized.', ' Derived', ' Shall', ' No'
164+
' docformatter_4.5.2', ' One-line docstrings will have the first word capitalized.', ' Derived', ' Shall', ' Yes'
165+
' 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]'
166+
' docformatter_4.5.3', ' Shall not place a newline after the first line of a wrapped one-line docstring.' ' Derived', ' Shall', ' Yes [PR #179]'
165167
' PEP_257_5','**Multi-line docstrings:**'
166168
' PEP_257_5.1',' A summary is just like a one-line docstring.',' Convention',' Shall',' Yes'
167169
' 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
196198
' docformatter_10.1.2', ' Should allow/disallow wrapping of one-line docstrings.', ' Derived', ' Should', ' No'
197199
' docformatter_10.1.3', ' Shall not wrap links that exceed the wrap length.', ' Derived', ' Shall', ' Yes [*PR #114*]'
198200
' 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*]'
201+
' docformatter_10.1.3.2', ' Shall not place a newline between description text and a wrapped link.', ' Derived', ' Shall', ' Yes [PR #182]'
199202
' docformatter_10.2', ' Should format docstrings using NumPy style.', ' Style', ' Should', ' No'
200203
' docformatter_10.3', ' Should format docstrings using Google style.', ' Style', ' Should', ' No'
201204
' docformatter_10.4', ' Should format docstrings using Sphinx style.',' Style', ' Should', ' No'

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "docformatter"
3-
version = "1.6.3"
3+
version = "1.6.4"
44
description = "Formats docstrings to follow PEP 257"
55
authors = ["Steven Myint"]
66
maintainers = [
@@ -220,6 +220,7 @@ commands =
220220
--cov=docformatter \
221221
--cov-config={toxinidir}/pyproject.toml \
222222
--cov-branch \
223+
--cov-append \
223224
{toxinidir}/tests/
224225
225226
[testenv:coverage]

src/docformatter/__pkginfo__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@
2323
# SOFTWARE.
2424
"""Package information for docformatter."""
2525

26-
__version__ = "1.6.3"
26+
__version__ = "1.6.4"

0 commit comments

Comments
 (0)