mirror of
https://github.com/kovidgoyal/calibre.git
synced 2025-07-08 18:54:09 -04:00
update docstring
This commit is contained in:
parent
f75f4db165
commit
f73cf23976
@ -912,13 +912,12 @@ class ResultCache(SearchQueryParser): # {{{
|
|||||||
def set_marked_ids(self, id_dict):
|
def set_marked_ids(self, id_dict):
|
||||||
'''
|
'''
|
||||||
ids in id_dict are "marked". They can be searched for by
|
ids in id_dict are "marked". They can be searched for by
|
||||||
using the search term ``marked:true``. Pass in an empty dictionary or
|
using the search term ``marked:true`` or ``marked:value``.
|
||||||
set to clear marked ids.
|
Pass in an empty dictionary or set to clear marked ids.
|
||||||
|
|
||||||
:param id_dict: Either a dictionary mapping ids to values or a set
|
:param id_dict: Either a dictionary mapping ids to values or a set
|
||||||
of ids. In the latter case, the value is set to 'true' for all ids. If
|
of ids. If a mapping is provided, then the search can be used to search
|
||||||
a mapping is provided, then the search can be used to search for
|
for particular values: ``marked:value``
|
||||||
particular values: ``marked:value``
|
|
||||||
'''
|
'''
|
||||||
if not hasattr(id_dict, 'items'):
|
if not hasattr(id_dict, 'items'):
|
||||||
# Simple list. Make it a dict of string 'true'
|
# Simple list. Make it a dict of string 'true'
|
||||||
|
Loading…
x
Reference in New Issue
Block a user