simonw/sqlite-utils

Tiny typographical error in install/uninstall docs

Open

#493 opened on Sep 26, 2022

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)Python (145 forks)github user discovery
bugdocumentationhelp wanted

Repository metrics

Stars
 (2,065 stars)
PR merge metrics
 (Avg merge 9h 52m) (7 merged PRs in 30d)

Description

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 direction
Locate the RST source file for the CLI documentation and replace the en dash (–) with a double hyphen ( ) in the line referenced. Then build the docs to verify the fix.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
GitSphinx / reStructuredText
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90