Skip to content

Commit 5948f6d

Browse files
authored
Add missing comma in requirements table (#261)
* Add missing comma This caused Sphinx to fail to render the entire table. * add docs tox testenv config
1 parent dfefe06 commit 5948f6d

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/source/requirements.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ the requirement falls in, the type of requirement, and whether
169169
' docformatter_4.5.2', ' One-line docstrings will have the first word capitalized.', ' Derived', ' Shall', ' Yes'
170170
' 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]'
171171
' docformatter_4.5.2.2', ' First words in one-line docstrings that are user-specified to not be capitalized shall remain unchanged.', ' Derived', ' Shall', ' Yes [PR #194]'
172-
' docformatter_4.5.3', ' Shall not place a newline after the first line of a wrapped one-line docstring.' ' Derived', ' Shall', ' Yes [PR #179]'
172+
' docformatter_4.5.3', ' Shall not place a newline after the first line of a wrapped one-line docstring.', ' Derived', ' Shall', ' Yes [PR #179]'
173173
' PEP_257_5','**Multi-line docstrings:**'
174174
' PEP_257_5.1',' A summary is just like a one-line docstring.',' Convention',' Shall',' Yes'
175175
' docformatter_5.1.1', ' The summary line shall satisfy all the requirements of a one-line docstring.', ' Derived', ' Shall', ' Yes'

pyproject.toml

+7
Original file line numberDiff line numberDiff line change
@@ -275,4 +275,11 @@ commands =
275275
pydocstyle {toxinidir}/src/docformatter
276276
ruff check --select "PL" --select "F" {toxinidir}/src/docformatter
277277
rstcheck --report-level=1 {toxinidir}/README.rst
278+
279+
[testenv:docs]
280+
description = build docformatter documentation
281+
allowlist_externals = make
282+
changedir = docs
283+
commands =
284+
make html
278285
"""

0 commit comments

Comments
 (0)