Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Address issue #197 re: handshake customization docs. #199

Closed
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix typo: origins -> origin.
cjerdonek committed Jul 30, 2017
commit 7416f876e06ff277e0408ca3310935e9e4b6abf2
4 changes: 2 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -57,14 +57,14 @@ method can be overridden to return a different :class:`~http.HTTPStatus`
member.

For example, the request headers can be examined and the request
authenticated before returning ``HTTPStatus.UNAUTHORIZED`` or
authenticated to decide whether to return ``HTTPStatus.UNAUTHORIZED`` or
``HTTPStatus.FORBIDDEN``. Similarly, the current request path can be
examined to check for ``HTTPStatus.NOT_FOUND``.

The following instance attributes are guaranteed to be available from
within this method:

* ``origins``
* ``origin``
* ``path``
* ``raw_request_headers``
* ``request_headers``