Skip to content

Commit b81521d

Browse files
committedSep 27, 2017
Use google doc style and resolve comments
1 parent bbfbd5f commit b81521d

File tree

1 file changed

+19
-24
lines changed

1 file changed

+19
-24
lines changed
 

‎odm2api/ODM2/services/readService.py

+19-24
Original file line numberDiff line numberDiff line change
@@ -543,30 +543,25 @@ def getPeople(self, ids=None, firstname=None, lastname=None):
543543
return None
544544

545545
def getAffiliations(self, ids=None, personfirst=None, personlast=None, orgcode=None):
546-
"""
547-
Retrieve a list of ODM2 Affiliation objects.
548-
549-
Parameters
550-
----------
551-
ids: list, default None
552-
List of AffiliationIDs
553-
personfirst: str, default None
554-
Person First Name
555-
personlast: str, default None
556-
Person Last Name
557-
orgcode: str, default None
558-
Organization Code
559-
560-
Returns
561-
-------
562-
List of Affiliation objects
563-
564-
Examples
565-
--------
566-
>>> read.getAffiliations(ids=[39,40])
567-
>>> read.getAffiliations(personfirst='Anthony',
568-
... personlast='Aufdenkampe')
569-
>>> read.getAffiliations(orgcode='LimnoTech')
546+
"""Retrieve a list of Affiliation objects.
547+
548+
If no arguments are passed to the function, or their values are None,
549+
all Affiliation objects in the database will be returned.
550+
551+
Args:
552+
ids (:obj:`list`, optional): List of AffiliationIDs. Defaults to None.
553+
personfirst (:obj:`str`, optional): Person First Name. Defaults to None.
554+
personlast (:obj:`str`, optional): Person Last Name. Defaults to None.
555+
orgcode (:obj:`str`, optional): Organization Code. Defaults to None.
556+
557+
Returns:
558+
list: List of Affiliation objects
559+
560+
Examples:
561+
>>> read.getAffiliations(ids=[39,40])
562+
>>> read.getAffiliations(personfirst='John',
563+
... personlast='Smith')
564+
>>> read.getAffiliations(orgcode='Acme')
570565
571566
"""
572567
q = self._session.query(Affiliations)

0 commit comments

Comments
 (0)
Please sign in to comment.