Update docstrings

This commit is contained in:
Lucas Verney 2016-02-07 15:47:55 +01:00
parent b2dbe2b8f9
commit 8cc93fc84c

View File

@ -150,6 +150,10 @@ def get_entry_by_filter(filename, filter, ignore_fields=[]):
""" """
Get an entry from a BibTeX file. Get an entry from a BibTeX file.
.. note ::
Returns the first matching entry.
:param filename: The name of the BibTeX file. :param filename: The name of the BibTeX file.
:param filter: A function returning ``True`` or ``False`` whether the \ :param filter: A function returning ``True`` or ``False`` whether the \
entry should be included or not. entry should be included or not.