PyCQA/flake8-bugbear

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

Open

#285 opened on Sep 18, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (116 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (1,116 stars)
PR merge metrics
 (Avg merge 4h 17m) (3 merged PRs in 30d)

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

Research direction
Identify where B950 performs line length checking and add logic to respect the max doc length configuration option from flake8 for docstrings.
Tech stack
python
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Pythonflake8
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70