From 5409920bfc71aa1727e87a38dac3df21719590dd Mon Sep 17 00:00:00 2001
From: Amir MOHAMMADI <amir.mohammadi@idiap.ch>
Date: Thu, 30 Nov 2017 12:01:39 +0100
Subject: [PATCH] Fix the sphinx warnings
---
bob/pad/base/database/database.py | 24 +++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/bob/pad/base/database/database.py b/bob/pad/base/database/database.py
index dc6138a..807376b 100644
--- a/bob/pad/base/database/database.py
+++ b/bob/pad/base/database/database.py
@@ -131,21 +131,23 @@ class PadDatabase(BioDatabase):
#################################################################
def all_files(self, groups=('train', 'dev', 'eval'), flat=False):
- """all_files(groups=('train', 'dev', 'eval')) -> files
+ """Returns all files of the database, respecting the current protocol.
+ The files can be limited using the ``all_files_options`` in the
+ constructor.
- Returns all files of the database, respecting the current protocol.
- The files can be limited using the ``all_files_options`` in the constructor.
+ Parameters
+ ----------
+ groups : str or tuple or None
+ The groups to get the data for. it should be some of ``('train',
+ 'dev', 'eval')`` or ``None``
- **Parameters:**
-
- groups : some of ``('train', 'dev', 'eval')`` or ``None``
- The groups to get the data for.
- flat : if True, it will merge the real and attack files into one list.
-
- **Returns:**
+ flat : bool
+ if True, it will merge the real and attack files into one list.
+ Returns
+ -------
files : [:py:class:`bob.pad.base.database.PadFile`]
- The sorted and unique list of all files of the database.
+ The sorted and unique list of all files of the database.
"""
realset = self.sort(self.objects(protocol=self.protocol, groups=groups, purposes='real', **self.all_files_options))
attackset = self.sort(self.objects(protocol=self.protocol, groups=groups, purposes='attack', **self.all_files_options))
--
GitLab