Files
deb-python-falcon/docs/api/util.rst
Kurt Griffiths 4142f1d6a3 feat(util): Make it easier to reference uri module and TimezoneGMT class (#891)
Previously "from falcon import uri" worked but "import falcon.uri" did
not. TimezoneGMT is already available from the front-door falcon
module, but the documentation referenced falcon.util.TimezoneGTM.

Fix this up and update the docs to suit.
2016-09-08 08:40:39 -06:00

28 lines
752 B
ReStructuredText

.. _util:
Utilities
=========
URI Functions
-------------
.. NOTE(kgriffs): Due to the way we have been hoisting uri into falcon,
.. sphinx can't import just falcon.uri (root cause TBD). Whether or not
.. the way we are hoisting things is legit (hint: probably not, this
.. is something to address in Falcon 2.0), sphinx can't handle it
.. by default so we have a custom extension to fix things up.
.. automodule:: falcon.uri
:members: encode, encode_value, decode, parse_host,
parse_query_string, unquote_string
Miscellaneous
-------------
.. automodule:: falcon
:members: deprecated, http_now, dt_to_http, http_date_to_dt,
to_query_str, get_http_status, get_bound_method
.. autoclass:: falcon.TimezoneGMT
:members: