From 087ab946bc82e30f010e98b35a8c8a600a89da46 Mon Sep 17 00:00:00 2001
From: Olegs NIKISINS <onikisins@italix03.idiap.ch>
Date: Mon, 8 May 2017 16:50:11 +0200
Subject: [PATCH] Slightly updated the doc of objects() function in BioDatabase
class
---
bob/bio/base/database/database.py | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/bob/bio/base/database/database.py b/bob/bio/base/database/database.py
index 01ec1090..0e367bb4 100644
--- a/bob/bio/base/database/database.py
+++ b/bob/bio/base/database/database.py
@@ -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:
--
GitLab