summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-09-11 22:02:06 -0400
committerChris McDonough <chrism@plope.com>2011-09-11 22:02:06 -0400
commitde774b2f67112f52222903053e95ded11522ec71 (patch)
tree73cf2c5728fc0ac648495164128b5aee7e1acd11
parentc5d1276ceee47b8a911a95e4c2144ba0eb9e0dfa (diff)
downloadpyramid-de774b2f67112f52222903053e95ded11522ec71.tar.gz
pyramid-de774b2f67112f52222903053e95ded11522ec71.tar.bz2
pyramid-de774b2f67112f52222903053e95ded11522ec71.zip
update docstring
-rw-r--r--pyramid/encode.py17
1 files changed, 9 insertions, 8 deletions
diff --git a/pyramid/encode.py b/pyramid/encode.py
index 9c3a8f7c7..826e6a662 100644
--- a/pyramid/encode.py
+++ b/pyramid/encode.py
@@ -13,19 +13,20 @@ def url_quote(s, safe=''):
different set of reserved characters that must be quoted.
RFC 2396 Uniform Resource Identifiers (URI): Generic Syntax lists
- the following reserved characters.
+ the following reserved characters::
- reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
- "$" | ","
+ reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
+ "$" | ","
Each of these characters is reserved in some component of a URL,
but not necessarily in all of them.
- Unlike the default version of this function in the Python stdlib,
- by default, the url_quote function is intended for quoting individual
- path segments instead of an already composed path that might have
- '/' characters in it. Thus, it *will* encode any '/' character it
- finds in a string. It is also slightly faster than the stdlib version.
+ Unlike the default version of this function in the Python stdlib, by
+ default, the url_quote function is intended for quoting individual path
+ segments instead of an already composed path that might have ``/``
+ characters in it. Thus, it *will* encode any ``/`` character it finds in a
+ string unless ``/`` is marked as 'safe'. It is also slightly faster than
+ the stdlib version.
"""
cachekey = (safe, always_safe)
try: