update docstring

This commit is contained in:
Kovid Goyal 2022-04-15 08:18:43 +05:30
parent f75f4db165
commit f73cf23976
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C

View File

@ -912,13 +912,12 @@ class ResultCache(SearchQueryParser): # {{{
def set_marked_ids(self, id_dict):
'''
ids in id_dict are "marked". They can be searched for by
using the search term ``marked:true``. Pass in an empty dictionary or
set to clear marked ids.
using the search term ``marked:true`` or ``marked:value``.
Pass in an empty dictionary or set to clear marked ids.
: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
a mapping is provided, then the search can be used to search for
particular values: ``marked:value``
of ids. If a mapping is provided, then the search can be used to search
for particular values: ``marked:value``
'''
if not hasattr(id_dict, 'items'):
# Simple list. Make it a dict of string 'true'