Skip to content

Commit bca9d1f

Browse files
committed
docs(service): say what search_entities actually counts
1 parent 5c26a76 commit bca9d1f

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

‎src/osw/service/ops/search.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,9 @@ def search_entities(ctx: Context, ask_query: str, limit: Optional[int] = None) -
5757
``limit`` defaults to ``OSW_MAX_RESULTS`` (100 when that is unset). A
5858
``limit=N`` written into the query itself wins over it.
5959
Returns ``{titles, count, truncated}``, where ``titles`` are full page
60-
names, ``count`` is how many the wiki returned and ``truncated`` reports
61-
that further matches may exist beyond them.
60+
names, ``count`` is how many came back once hits whose page does not
61+
exist were dropped, and ``truncated`` reports that further matches may
62+
exist beyond them.
6263
"""
6364
lim = ctx.limit(limit)
6465
titles = ctx.osw.site.semantic_search(

0 commit comments

Comments
 (0)