Commit 087ab946 authored by Olegs NIKISINS's avatar Olegs NIKISINS
Browse files

Slightly updated the doc of objects() function in BioDatabase class

parent 9dbcc4e2
Pipeline #8919 passed with stages
in 18 minutes and 4 seconds
......@@ -301,7 +301,8 @@ class BioDatabase(six.with_metaclass(abc.ABCMeta, bob.db.base.Database)):
@abc.abstractmethod
def objects(self, groups=None, protocol=None, purposes=None, model_ids=None, **kwargs):
"""This function returns lists of File objects, which fulfill the given restrictions.
"""This function returns a list of :py:class:`bob.bio.base.database.BioFile` objects or the list
of objects which inherit from this class. Returned files fulfill the given restrictions.
Keyword parameters:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment