summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIra Lun <sammyrosajoe@gmail.com>2017-06-16 23:36:52 +0100
committerIra Lun <sammyrosajoe@gmail.com>2017-06-16 23:36:52 +0100
commitab718527c0793b3b3ce664e9f80c17d166afb6b3 (patch)
tree91f6a2538627b29c1a566d0c7f6c3af24906774c
parenta03c5222f6e728ccb455cd0d57f79a92d7fc0764 (diff)
downloadwebob-ab718527c0793b3b3ce664e9f80c17d166afb6b3.tar.gz
Add some basic docstrings for Sphinx autodoc.
-rw-r--r--src/webob/acceptparse.py22
1 files changed, 20 insertions, 2 deletions
diff --git a/src/webob/acceptparse.py b/src/webob/acceptparse.py
index c097581..5eb5f16 100644
--- a/src/webob/acceptparse.py
+++ b/src/webob/acceptparse.py
@@ -168,6 +168,10 @@ class Accept(object):
class NilAccept(object):
+ """
+ Represents a generic ``Accept-*`` style header when it is not present in
+ the request or is empty.
+ """
MasterClass = Accept
def __repr__(self):
@@ -217,10 +221,17 @@ class NilAccept(object):
return best_offer
class NoAccept(NilAccept):
+ """
+ Represents an ``Accept-Encoding`` header when it is not present in the
+ request or is empty.
+ """
def __contains__(self, item):
return False
class AcceptCharset(Accept):
+ """
+ Represents an ``Accept-Charset`` header.
+ """
@staticmethod
def parse(value):
latin1_found = False
@@ -240,6 +251,9 @@ class AcceptEncoding(Accept):
class AcceptLanguage(Accept):
+ """
+ Represents an ``Accept-Language`` header.
+ """
def _match(self, mask, item):
item = item.replace('_', '-').lower()
mask = mask.lower()
@@ -252,9 +266,9 @@ class AcceptLanguage(Accept):
class MIMEAccept(Accept):
"""
- Represents the ``Accept`` header, which is a list of mimetypes.
+ Represents an ``Accept`` header, which is a list of mimetypes.
- This class knows about mime wildcards, like ``image/*``
+ This class knows about mime wildcards, like ``image/*``
"""
@staticmethod
def parse(value):
@@ -340,6 +354,10 @@ class MIMEAccept(Accept):
class MIMENilAccept(NilAccept):
+ """
+ Represents an ``Accept`` header when it is not present in the request or is
+ empty.
+ """
MasterClass = MIMEAccept
def _check_offer(offer):