Skip to content

Commit

Permalink
docs: add documentation about 'exhaust' parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
anesson-cs committed Jul 15, 2024
1 parent ebc38b2 commit 739d639
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/notebooks/api_user_guide/7_download.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -630,7 +630,11 @@
"* `outputs_prefix` (`str`): absolute path to a folder where the products should be saved\n",
"* `extract` (`bool`): whether to automatically extract or not the downloaded product archive\n",
"* `dl_url_params` (`dict`): additional parameters to pass over to the download url as an url parameter\n",
"* `delete_archive` (`bool`): whether to delete the downloaded archives"
"* `delete_archive` (`bool`): whether to delete the downloaded archives\n",
"\n",
"An additionnal kwarg is accepted with the [download_all()](../../api_reference/core.rst#eodag.api.core.EODataAccessGateway.download_all) method:\n",
"\n",
"* `exhaust` (`bool`): whether to download products from all pages of the search request used to get the results in arguments."
]
},
{
Expand Down Expand Up @@ -979,6 +983,13 @@
"dag.download_all(products_to_download)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"If the [SearchResult](../../api_reference/searchresult.rst#eodag.api.search_result.SearchResult) argument does not come from the [search_all()](../../api_reference/core.rst#eodag.api.core.EODataAccessGateway.search_all) method, the `exhaust` argument can be set to `True` (default to `False`) to download products from all pages of the search request used to get the results in arguments by doing a new search on their provider with their search kwargs."
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down

0 comments on commit 739d639

Please sign in to comment.