Skip to content

Commit

Permalink
Add missing comma in requirements table (#261)
Browse files Browse the repository at this point in the history
* Add missing comma

This caused Sphinx to fail to render the entire table.

* add docs tox testenv config
  • Loading branch information
EFord36 committed Aug 9, 2023
1 parent dfefe06 commit 5948f6d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/source/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ the requirement falls in, the type of requirement, and whether
' 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.2.2', ' First words in one-line docstrings that are user-specified to not be capitalized shall remain unchanged.', ' Derived', ' Shall', ' Yes [PR #194]'
' docformatter_4.5.3', ' Shall not place a newline after the first line of a wrapped one-line docstring.' ' Derived', ' Shall', ' Yes [PR #179]'
' 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'
Expand Down
7 changes: 7 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -275,4 +275,11 @@ commands =
pydocstyle {toxinidir}/src/docformatter
ruff check --select "PL" --select "F" {toxinidir}/src/docformatter
rstcheck --report-level=1 {toxinidir}/README.rst
[testenv:docs]
description = build docformatter documentation
allowlist_externals = make
changedir = docs
commands =
make html
"""

0 comments on commit 5948f6d

Please sign in to comment.