Skip to content

docs: fix a broken emphasis and an idiom in the docs - #2176

Open
ump45nose wants to merge 1 commit into
spf13:masterfrom
ump45nose:docs/fix-two-doc-typos
Open

ump45nose wants to merge 1 commit into
spf13:masterfrom
ump45nose:docs/fix-two-doc-typos

Conversation

@ump45nose

Copy link
Copy Markdown

Overview:

Two documentation text fixes, no code changes:

  • TROUBLESHOOTING.md:23 — the tl;dr line opens a bold span with ** but closes it with a single *:

    **tl;dr* `export GO111MODULE=on`
    

    The emphasis run is mismatched: it is opened with a two-character ** delimiter run and closed
    with a one-character *, so the line does not render as the intended bold label. Every other
    tl;dr line in the docs uses the correct form (README.md:716 and README.md:744 both say
    **tl;dr:** Yes. / **tl;dr:** No.), so this PR aligns line 23 with them:
    **tl;dr:** export GO111MODULE=on``.

  • README.md:164 — "As a rule of the thumb" should be the idiom "As a rule of thumb".

What problem does it solve?:

The broken emphasis makes the one-line answer to the most-Googled Viper installation error look
like a markup mistake in rendered output, and the README sentence reads as a translation artifact.
Both are pure prose fixes; nothing in the API or behaviour changes.

Closes: N/A — no open issue covers these two lines.

Special notes for a reviewer:

TROUBLESHOOTING.md opened a bold span with '**' and closed it with a single '*', so the line rendered as literal asterisks. README.md said 'a rule of the thumb'; the idiom is 'a rule of thumb'.

Signed-off-by: yuwk <1729065730@qq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant