Skip to content

Commit bdd6a2f

Browse files
committed
Fix docstrings
1 parent df3c13c commit bdd6a2f

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/scholarag/app/routers/retrieval.py

+9-9
Original file line numberDiff line numberDiff line change
@@ -201,15 +201,15 @@ async def article_count(
201201
Parameters
202202
----------
203203
ds_client
204-
Document store client
204+
Document store client.
205205
filter_query
206206
Filtering query for paragraph retrieval.
207207
settings
208-
Global settings of the application
209-
topics
210-
Keyword to be matched in text.
208+
Global settings of the application.
209+
topics
210+
Keywords to be matched in text. AND matches list elements.
211211
regions
212-
Keyword to be matched in text.
212+
Keywords to be matched in text. OR matches list elements.
213213
214214
Returns
215215
-------
@@ -366,15 +366,15 @@ async def article_listing(
366366
filter_query
367367
Filtering query for paragraph retrieval.
368368
settings
369-
Global settings of the application
369+
Global settings of the application.
370370
topics
371-
Keyword to be matched in text. OR matching.
371+
Keywords to be matched in text. AND matches list elements.
372372
regions
373-
Keyword to be matched in text. OR matching.
373+
Keywords to be matched in text. OR matches list elements.
374374
number_results
375375
Number of results to return. Max 10 000.
376376
sort_by_date
377-
Sort by date True or False. If the latter, we sort by relevance
377+
Sort by date True or False. If the latter, we sort by best match.
378378
379379
Returns
380380
-------

0 commit comments

Comments
 (0)