simonw/sqlite-utils

Tiny typographical error in install/uninstall docs

Offen

#493 geöffnet am 26.09.2022

Auf GitHub ansehenContributor Guide
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (145 Forks)github user discovery
bugdocumentationhelp wanted

Repository-Metriken

Stars
 (2.065 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 9h 52m) (7 gemergte PRs in 30 T)

Beschreibung

Added in:

  • #483

I don't know how to fix this in Sphinx: I'm getting this: https://sqlite-utils.datasette.io/en/latest/cli.html#cli-install

The insert –convert and query –functions options

But I want it to display insert --convert and not insert –convert there.

Here's the code: https://github.com/simonw/sqlite-utils/blob/85247038f70d7eb2f3e272cfeaa4c44459cafba8/docs/cli.rst#L2125

Contributor Guide

Research-Richtung
Finde die RST Quelldatei für die CLI Dokumentation und ersetze den Gedankenstrich (–) in der referenzierten Zeile durch einen doppelten Bindestrich ( ). Baue dann die Dokumentation neu, um die Korrektur zu überprüfen.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
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
GitSphinx / reStructuredText
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90