Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix parse_string docstring

This commit is contained in:
Richard van der Hoff 2018-11-08 11:12:29 +00:00
parent de6223836e
commit 0a1fc52971
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
synapse/http/servlet.py
View File

@ -121,16 +121,15 @@ def parse_string(request, name, default=None, required=False,
Args: Args:
request: the twisted HTTP request. request: the twisted HTTP request.
name (bytes/unicode): the name of the query parameter. name (bytes|unicode): the name of the query parameter.
default (bytes/unicode|None): value to use if the parameter is absent, default (bytes|unicode|None): value to use if the parameter is absent,
defaults to None. Must be bytes if encoding is None. defaults to None. Must be bytes if encoding is None.
required (bool): whether to raise a 400 SynapseError if the required (bool): whether to raise a 400 SynapseError if the
parameter is absent, defaults to False. 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 string, or None if any value is allowed, defaults to None. Must be
the same type as name, if given. the same type as name, if given.
encoding: The encoding to decode the name to, and decode the string encoding (str|None): The encoding to decode the string content with.
content with.
Returns: Returns:
bytes/unicode|None: A string value or the default. Unicode if encoding bytes/unicode|None: A string value or the default. Unicode if encoding