diff options
| author | Erik Johnston <erik@matrix.org> | 2019-02-25 15:08:18 +0000 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2019-02-25 15:08:18 +0000 |
| commit | 4b9e5076c40964a967a48a2c02623c81a43265aa (patch) | |
| tree | ae977487f07c0e64e406ada53655b3f69edb664e /synapse/http/servlet.py | |
| parent | Docs and arg name clarification (diff) | |
| parent | Merge pull request #4723 from matrix-org/erikj/frontend_proxy_exception (diff) | |
| download | synapse-4b9e5076c40964a967a48a2c02623c81a43265aa.tar.xz | |
Merge branch 'develop' of github.com:matrix-org/synapse into anoa/public_rooms_federate
Diffstat (limited to 'synapse/http/servlet.py')
| -rw-r--r-- | synapse/http/servlet.py | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/synapse/http/servlet.py b/synapse/http/servlet.py index a1e4b88e6d..528125e737 100644 --- a/synapse/http/servlet.py +++ b/synapse/http/servlet.py @@ -121,16 +121,15 @@ def parse_string(request, name, default=None, required=False, Args: request: the twisted HTTP request. - name (bytes/unicode): the name of the query parameter. - default (bytes/unicode|None): value to use if the parameter is absent, + name (bytes|unicode): the name of the query parameter. + default (bytes|unicode|None): value to use if the parameter is absent, defaults to None. Must be bytes if encoding is None. required (bool): whether to raise a 400 SynapseError if the parameter is absent, defaults to False. - allowed_values (list[bytes/unicode]): List of allowed values for the + allowed_values (list[bytes|unicode]): List of allowed values for the string, or None if any value is allowed, defaults to None. Must be the same type as name, if given. - encoding: The encoding to decode the name to, and decode the string - content with. + encoding (str|None): The encoding to decode the string content with. Returns: bytes/unicode|None: A string value or the default. Unicode if encoding |