docs: clarify quote/squote escaping behavior#483
Open
Solaris-star wants to merge 1 commit into
Open
Conversation
Document that quote uses Go %q escaping (not only wrapping) and that squote only adds surrounding single quotes without Go string escaping. Fixes Masterminds#481
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.
Description
The docs for
quote/squoteonly said they wrap a string in quotes.quoteactually uses Go's%qverb (fmt.Sprintf("%q", ...)), so contents are escaped with Go string syntax.squoteonly adds surrounding single quotes without that escaping.Fix
Expand the
quote and squotesection indocs/strings.mdto describe escaping behavior and give simple examples.Linked Issue
Closes #481