docs: render insert --convert and query --functions with literal hyphens - #844
Open
jennifferweslowski-design wants to merge 1 commit into
Open
Conversation
Sphinx smartquotes turns -- into an en-dash inside :ref: display text. Use code roles so the CLI flags stay copyable. Fixes simonw#493
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Sphinx smartquotes turns
--into an en-dash when those flags sit in:ref:display text, so the install docs showedinsert –convertandquery –functions.Moved the flags into RST code roles (
``--convert``/``--functions``) and left the:ref:links oninsertandquery. Smartquotes does not rewrite literals, so the CLI flags stay copyable.Fixes #493
Test plan
cli.html#cli-installshowsinsert --convertandquery --functions(two hyphens, not an en-dash)insertandquerywords still link tocli_insert_convertandcli_query_functions📚 Documentation preview 📚: https://sqlite-utils--844.org.readthedocs.build/en/844/