PyCQA / PyCQA/docformatter

docformatter omits pyproject.toml configuration when has no extra dependencies installed

Open
#268 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C: stakeholder P: bug U: medium
Dominant language
Python
Stars
598
Forks
93
PR merge metrics
No merged PRs in 30d

Description

I have a pyproject.toml file containing some entries for black, ruff and docformatter. When I install the latest docformatter in a clean environment it does not read the configuration from the config file, simply omits it even if it's explicitly specified. The other formatters have no issue reading the same file.

My pyproject toml:

[tool.docformatter]
black = true
recursive = true
in-place = true
wrap-summaries = 120
wrap-descriptions = 120

I believe the behavior is exactly the same as in this old issue.

Issue is present in docformatter version 1.7.5, tested on multiple Python versions with the same results.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the report with the shown pyproject.toml configuration in a clean environment using docformatter 1.7.5. Check whether the tool reads the [tool.docformatter] entries when no extra dependencies are installed; done means the documented options are applied without requiring unrelated dependencies.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.