Repository navigation
Conversation
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>
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
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.
Overview:
Two documentation text fixes, no code changes:
TROUBLESHOOTING.md:23— thetl;drline opens a bold span with**but closes it with a single*:The emphasis run is mismatched: it is opened with a two-character
**delimiter run and closedwith a one-character
*, so the line does not render as the intended bold label. Every othertl;drline in the docs uses the correct form (README.md:716andREADME.md:744both 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:
viper.go:201("By default it's value is "."") alone even though it is thesame class of typo: PR fix: normalize key delimiter to lowercase for nested lookups (#2069) #2175 changes the line right below it inside the same hunk context, so
touching it here would needlessly conflict.
README.md: the open PRs that edit the file (docs: clarify extensionless config handling and SetConfigType usage #2155, docs: explain custom configuration file searches #2172, docs: fix typos in README.md and UPGRADE.md #2150, docs: update supported formats list for v1.20 changes #2102, Update README to clarify HCL, INI, and Java Properties support moved to plugin #2098)all land in the "Reading Config Files"/"Setting Overrides" regions (lines 92–146 and 220–226), so
none of them edits line 164. On
TROUBLESHOOTING.md, docs: point TROUBLESHOOTING at the maintained mapstructure fork #2162 edits line 5 and docs: TROUBLESHOOTING points at a viper_yaml3 build tag that is gone #2168 edits line 32,neither of which is line 23.
make test/go test ./...was not run in my sandbox, andmarkdownlint is not configured in this repo (
.golangci.yamllints Go code,.yamllint.yamlcovers YAML). I verified the broken delimiter run and the two correct
tl;drlines already inREADME.mdby reading upstreammaster.master(
528f741) myself.