Skip to content

docs: align to_date docstrings with API defaults #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Shedna wants to merge 1 commit into from
Closed

docs: align to_date docstrings with API defaults #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions src/linkup/_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,8 +236,8 @@ def search(
datetime.date, YYYY-MM-DD, or full ISO datetime string. If None, the search
results will not be filtered by date.
to_date: The date until which the search results should be considered. Accepts a
datetime.date, YYYY-MM-DD, or full ISO datetime string. If None, the search
results will not be filtered by date.
datetime.date, YYYY-MM-DD, or full ISO datetime string. If None, the Linkup API
applies its current default end date.
exclude_domains: If you want to exclude specific domains from your search.
include_domains: If you want the search to only return results from certain domains.
max_results: The maximum number of results to return.
Expand Down Expand Up @@ -433,8 +433,8 @@ async def async_search(
datetime.date, YYYY-MM-DD, or full ISO datetime string. If None, the search
results will not be filtered by date.
to_date: The date until which the search results should be considered. Accepts a
datetime.date, YYYY-MM-DD, or full ISO datetime string. If None, the search
results will not be filtered by date.
datetime.date, YYYY-MM-DD, or full ISO datetime string. If None, the Linkup API
applies its current default end date.
exclude_domains: If you want to exclude specific domains from your search.
include_domains: If you want the search to only return results from certain domains.
max_results: The maximum number of results to return.
Expand Down Expand Up @@ -524,8 +524,8 @@ def research(
datetime.date, YYYY-MM-DD, or full ISO datetime string. If None, sources will
not be filtered by a start date.
to_date: The date until which the research sources should be considered. Accepts a
datetime.date, YYYY-MM-DD, or full ISO datetime string. If None, sources will
not be filtered by an end date.
datetime.date, YYYY-MM-DD, or full ISO datetime string. If None, the Linkup API
applies its current default end date.
exclude_domains: Domains to exclude from the research sources.
include_domains: Domains to restrict the research sources to.
timeout: The timeout for the HTTP request, in seconds. If None, the request will have
Expand Down Expand Up @@ -597,8 +597,8 @@ async def async_research(
datetime.date, YYYY-MM-DD, or full ISO datetime string. If None, sources will
not be filtered by a start date.
to_date: The date until which the research sources should be considered. Accepts a
datetime.date, YYYY-MM-DD, or full ISO datetime string. If None, sources will
not be filtered by an end date.
datetime.date, YYYY-MM-DD, or full ISO datetime string. If None, the Linkup API
applies its current default end date.
exclude_domains: Domains to exclude from the research sources.
include_domains: Domains to restrict the research sources to.
timeout: The timeout for the HTTP request, in seconds. If None, the request will have
Expand Down
Loading