Makes uri_escape template docs more specific. #5887
Merged
Conversation
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
I didn't know the difference between cgi_escape and uri_escape until it bit me when I had a colon in a title I used uri_escape on. Addressable::URI.encode (from addressable 2.4.0 and later) thought it was a URI and raised an error. I should have been using cgi_escape, which is for strings that will be added to URIs and not uri_escape, which is for encoding strings that are already in a URI. This commit borrows from t 8000 he addressable docs to make it more specific so that readers choose uri_escape when they already have a URI and cgi_escape when they are just escaping a plain string.
ghost
approved these changes
Feb 17, 2017
|
@jekyllbot: merge +docs |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
I didn't know the difference between
cgi_escapeanduri_escapeuntil it bit me when I had a colon in a title I useduri_escapeon. Addressable::URI.encode (from addressable 2.4.0 and later) thought it was a URI and raised an error. I should have been usingcgi_escape, which is for strings that will be added to URIs and noturi_escape, which is for encoding strings that are already in a URI.This commit borrows from the addressable docs to make the
uri_escapeexplanation more specific so that readers chooseuri_escapewhen they already have a URI andcgi_escapewhen they are just escaping a plain string.