PyCQA / PyCQA/flake8-bugbear

`B950` ignores `max-doc-length` flake8 configuration option

Open
#285 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
Dominant language
Python
Stars
1.1k
Forks
123
Avg merge
2d 5h
Merged PRs (30d)
5

Description

flake8 has a configuration option max-doc-length, which configures the maximum line length for docstrings. flake8-bugbear currently ignores this setting.
It makes sense to limit line length of code to ~80-88 for smaller screen sizes, diffs etc. Especially within tests though, limiting docstring line length to the same value can cause very awkward docstring formatting, severely limiting readability.

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

No file or test is named. Start by locating the B950 implementation and how flake8 configuration is read; then trace the handling of docstring line lengths. Done means max-doc-length affects B950 docstring checks while ordinary code line-length behavior remains unchanged, with coverage for the configuration case.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.