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.

Sign up for GitHub

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

Improve getAffiliation docstring to follow numpy/scipy documentation #98

Merged
merged 2 commits into from
Sep 27, 2017
Merged

Improve getAffiliation docstring to follow numpy/scipy documentation #98

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bbfbd5f
Improve getAffiliation docstring to follow numpy/scipy documentation
lsetiawan Sep 27, 2017
b81521d
Use google doc style and resolve comments
lsetiawan Sep 27, 2017
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
27 changes: 20 additions & 7 deletions odm2api/ODM2/services/readService.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -543,13 +543,26 @@ def getPeople(self, ids=None, firstname=None, lastname=None):
return None

def getAffiliations(self, ids=None, personfirst=None, personlast=None, orgcode=None):
"""
getAffiliations(self, ids=None, personfirst=None, personlast=None, orgcode=None)
* Pass nothing - returns a list of all Affiliation objects
* Pass a list of AffiliationID - returns a single Affiliation object
* Pass a First Name - returns a single Affiliation object
* Pass a Last Name - returns a single Affiliation object
* Pass an OrganizationCode - returns a Affiliation object
"""Retrieve a list of Affiliation objects.

If no arguments are passed to the function, or their values are None,
all Affiliation objects in the database will be returned.

Args:
ids (:obj:`list`, optional): List of AffiliationIDs. Defaults to None.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ocefpaf Is the :obj: necessary?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will link to the standard lib docs on that object. Hover over/clock the bool here and you'll see that in action. But no, we don't really need that.

personfirst (:obj:`str`, optional): Person First Name. Defaults to None.
personlast (:obj:`str`, optional): Person Last Name. Defaults to None.
orgcode (:obj:`str`, optional): Organization Code. Defaults to None.

Returns:
list: List of Affiliation objects

Examples:
>>> read.getAffiliations(ids=[39,40])
>>> read.getAffiliations(personfirst='John',
... personlast='Smith')
>>> read.getAffiliations(orgcode='Acme')

"""
q = self._session.query(Affiliations)

Expand Down