add doc string for **filters
@@ -166,13 +166,24 @@ class BIDSLayoutIndexer(object):
self._index_dir(self.root, self.config)
def index_metadata(self, **filters):
- """Index metadata for all files in the BIDS dataset. """
+ """Index metadata for all files in the BIDS dataset.
+
+ Parameters
+ ----------
+
+ **filters
+ keyword arguments passed to the .get() method of a
+ :obj:`bids.layout.BIDSLayout` object.
+ These keyword arguments define what files get selected
+ for metadata indexing.
+ """
+
if filters:
# ensure we are returning objects
filters['return_type'] = 'object'
# until 0.11.0, user can specify extension or extensions
ext_key = 'extensions' if 'extensions' in filters else 'extension'
- if filters.get(ext_key, None):
+ if filters.get(ext_key):
filters[ext_key] = listify(filters[ext_key])
# ensure json files are being indexed
if 'json' not in filters[ext_key]:
