PyCQA/flake8-bugbear

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

Offen

#285 geöffnet am 18.09.2022

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (116 Forks)github user discovery
enhancementhelp wanted

Repository-Metriken

Stars
 (1.116 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 4h 17m) (3 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Identifiziere, wo B950 die Zeilenlängenprüfung durchführt, und füge Logik hinzu, um die max doc length Konfigurationsoption von flake8 für Docstrings zu beachten.
Tech Stack
python
Domain
backend
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Pythonflake8
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70