summaryrefslogtreecommitdiff
path: root/pygerrit/models.py
diff options
context:
space:
mode:
authorDavid Pursehouse <david.pursehouse@sonymobile.com>2012-07-31 09:38:59 +0900
committerDavid Pursehouse <david.pursehouse@sonymobile.com>2012-07-31 11:45:40 +0900
commit65106ac065be9239fdaa0f9da7933564156f6d1e (patch)
tree36f823d7894309aa4761f6b46ad6f15495fddafe /pygerrit/models.py
parentb6ba6d314ad8f764daa5ea8a2774c69439093c77 (diff)
downloadpygerrit-65106ac065be9239fdaa0f9da7933564156f6d1e.tar.gz
Tidy up docstrings to follow the PEP-257 docstring convention0.0.2
http://www.python.org/dev/peps/pep-0257/ Change-Id: I1469a94f01660ef00aac196a5ca8995b3803a4bd
Diffstat (limited to 'pygerrit/models.py')
-rw-r--r--pygerrit/models.py28
1 files changed, 10 insertions, 18 deletions
diff --git a/pygerrit/models.py b/pygerrit/models.py
index 9f3b787..c8c70d5 100644
--- a/pygerrit/models.py
+++ b/pygerrit/models.py
@@ -4,10 +4,8 @@ from pygerrit.error import GerritError
class Account(object):
- ''' Representation of the Gerrit user account (name and email address)
- described in `json_data`.
- Raise GerritError if name or email address field is missing.
- '''
+
+ """ Gerrit user account (name and email address). """
def __init__(self, json_data):
try:
@@ -21,9 +19,8 @@ class Account(object):
class Change(object):
- ''' Representation of the Gerrit change described in `json_data`.
- Raise GerritError if any of the required fields is missing.
- '''
+
+ """ Gerrit change. """
def __init__(self, json_data):
try:
@@ -39,9 +36,8 @@ class Change(object):
class Patchset(object):
- ''' Representation of the Gerrit patch set described in `json_data`.
- Raise GerritError if any of the required fields is missing.
- '''
+
+ """ Gerrit patch set. """
def __init__(self, json_data):
try:
@@ -54,11 +50,8 @@ class Patchset(object):
class Approval(object):
- ''' Representation of a Gerrit approval (verification, code review, etc)
- described in `json_data`.
- Raise GerritError if a required field is missing or has an
- unexpected value.
- '''
+
+ """ Gerrit approval (verified, code review, etc). """
def __init__(self, json_data):
if "type" not in json_data:
@@ -74,9 +67,8 @@ class Approval(object):
class RefUpdate(object):
- ''' Representation of the Gerrit ref update described in `json_data`.
- Raise GerritError if any of the required fields is missing.
- '''
+
+ """ Gerrit ref update. """
def __init__(self, json_data):
try: