Config file undocumented?
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 25/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- python
- Bereich
- documentation
Rechercherichtung
Start by comparing the configuration file options with the options shown by codespell --help, focusing on whether each command-line option has a config equivalent and what values it accepts. Check how count and check-hidden are handled, then document the supported config syntax and verify that the examples work; the issue does not name any files or tests.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
I might have missed it but it seems to me that the config file is nearly undocumented.
I can see all (?) possible config options via codespell --help. But these are for the command line. It is not clear if this options do have an equivalent in the config file and what values they should have.
For example it seems that I can do count = True in the config file. But from reading --help it was not clear that True is the correct value.
Or --check-hidden is totally unclear. It works on command line but when I do check-hidden = True I got codespell: error: unrecognized arguments: True. So I don't know how to configure check-hidden via config file.
- Vorherrschende Sprache
- Python
- Sterne
- 2.4k
- Forks
- 531
- Ø Merge
- 15 Std. 5 Min.
- Gemergte PRs (30 T.)
- 18
Entwicklungsumgebung
Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Kein Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus codespell-project/codespell
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
codespell-project/codespell#3997 ·
Maintainer antworten meist innerhalb von 1 Tag
-
enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 63/100
codespell-project/codespell#3965 · 3 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
Add "marcos"Evtl. vergeben @ekanshul hat das vor 19 Tagen übernommen. Offendictionary
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
codespell-project/codespell#3920 · 3 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
question
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
codespell-project/codespell#4005 ·
Maintainer antworten meist innerhalb von 1 Tag
-
duplicate question
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 35/100
codespell-project/codespell#3998 ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in codespell-project/codespell
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
btclib-org/btclib-ecc#404 ·
-
changelog investigate
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 78/100
ramnes/notion-sdk-py#430 ·
-
bug good first issue
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 91/100
hyeonjoong/debussy#56 ·
-
README устарел: статус проекта, версия 0.1.0 при описании тега v0.1.1, семантика фолбэка поискаOffendocumentation
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
Lagrunge82/yandex-mail-mcp#43 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
liberation-data/drivine-python#252 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag