Python Function Comment

November 28, 2019
def request(headers, path_params, query_params, body_value):
    """Updates outgoing requests with a serialized body.
    Line 2
    Line 3

    Args:
      headers: dict, request headers
      path_params: dict, parameters that appear in the request path
      query_params: dict, parameters that appear in the query
      body_value: object, the request body as a Python object, which must be
                  serializable by json.
    Returns:
      A tuple of (headers, path_params, query, body)
      headers: dict, request headers
      path_params: dict, parameters that appear in the request path
      query: string, query part of the request URI
      body: string, the body serialized as JSON
    """
    pass

NOTE: PEP 257 - Docstring Conventions

This work is licensed under a
Creative Commons Attribution-NonCommercial 4.0 International License.