search

PyCQA / docformatter

Formats docstrings to follow PEP 257
https://pypi.python.org/pypi/docformatter
MIT License
524 stars 61 forks source link

Add missing comma in requirements table #261

Closed EFord36 closed 11 months ago

EFord36 commented 11 months ago

Closes #260

This caused Sphinx to fail to render the entire table.

After this change, the Sphinx error has gone away and the table renders:

Screenshot 2023-08-08 at 15 31 39

weibullguy commented 11 months ago

@EFord36 would you be amenable to adding the following testenv for tox in pyproject.toml?


[testenv:docs]
description = build docformatter documentation
allowlist_externals = make
changedir = docs
commands =
    make html

Just add that between this line -> rstcheck --report-level=1 {toxinidir}/README.rst and the closing """ at the very end of the file. No worries if you don't want to, it just saves another PR. TIA

EFord36 commented 11 months ago

sure, I'll look at that now. Thanks for letting me know the issue!

EFord36 commented 11 months ago

@weibullguy I just pushed a new commit to the branch with that change - let me know if I've made any mistake, or you want any more explanation/detail in the commit message or anything!

weibullguy commented 11 months ago

sure, I'll look at that now. Thanks for letting me know the issue!

Wasn't an issue, I was just trying to get you to do something I'd have to do later! :wink: