Skip to content

Commit

Permalink
Merge pull request #86 from danibene/docs/search_semanticscholar_query
Browse files Browse the repository at this point in the history
[Docs] add link to API documentation on semantic scholar query
  • Loading branch information
stijnh authored Feb 21, 2024
2 parents ca7fc5d + c440e36 commit 9a2d9c6
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion litstudy/sources/semanticscholar.py
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,8 @@ def search_semanticscholar(
query: str, *, limit: int = None, batch_size: int = 100, session=None
) -> DocumentSet:
"""Submit the given query to SemanticScholar API and return the results
as a `DocumentSet`.
as a `DocumentSet`. The query is a string containg keywords (see `API reference
<https://www.semanticscholar.org/product/api%2Ftutorial#using-search-query-operators>`_).
:param query: The search query to submit.
:param limit: The maximum number of results to return.
Expand Down

0 comments on commit 9a2d9c6

Please sign in to comment.