Skip to content

Commit

Permalink
docs: update 'SearchResult' class docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
anesson-cs committed Aug 6, 2024
1 parent f46041c commit 555375b
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions eodag/api/search_result.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,15 @@ class SearchResult(UserList):
:param products: A list of products resulting from a search
:param number_matched: (optional) the estimated total number of matching results
:cvar data: List of products
:vartype data: List[EOProduct]
:ivar number_matched: Estimated total number of matching results
:vartype number_matched: Optional[int]
:ivar search_kwargs: (optional) The search kwargs used by eodag to search for the product
:vartype search_kwargs: Optional[Dict[str, Any]]
:ivar crunchers: The list of crunchers used to filter these products
:vartype crunchers: List[Crunch]
:vartype crunchers: Set[Crunch]
"""

data: List[EOProduct]
Expand All @@ -58,7 +60,7 @@ def __init__(
self, products: List[EOProduct], number_matched: Optional[int] = None
) -> None:
super(SearchResult, self).__init__(products)
self.number_matched = number_matched
self.number_matched: Optional[int] = number_matched
self.search_kwargs: Optional[Dict[str, Any]] = None
self.crunchers: Set[Crunch] = set()

Expand Down

0 comments on commit 555375b

Please sign in to comment.