-
Notifications
You must be signed in to change notification settings - Fork 81
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.
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
search_data
& search_datasets
documentation parameter list is incomplete
#345
Comments
search_data
documentation includes cloud_hosted
parameter in example, but not in parameter listsearch_data
documentation parameter list is incomplete
I am currently working on updating the |
Hi, i have the same difficulties. I wanted to download AST L1T data and download it with a filter based on cloud coverage. Is it possible to print a dataframe with the dates and specifications such as Day/ night and cloud coverage? Thanks in advance |
Hey @paolodep36, thanks for posting your question! Is there a specific parameter you're expecting to see in the docs for
|
More confusion that I think comes from this docs problem: #478 In this case the undocumented parameter was |
More pain for our users: #504 (comment) I'm going to pin this. |
search_data
documentation parameter list is incompletesearch_data
& search_datasets
documentation parameter list is incomplete
search_data
includes undocumented parametercloud_hosted
in its example.downloadable
parameter is not documented.Currently,
kwargs
are passed fromsearch_data
to aDataGranules
object'sparameters
method, which also acceptskwargs
. The possible keys are fixed by the methods onDataGranules
, and populated dynamically by matching keys to method names.earthaccess/earthaccess/api.py
Lines 116 to 119 in ff0c59a
The same technique is used for both data & dataset search functions.
However, the interface is untyped and the documentation is generated from a hand-maintained docstring. I feel we should move towards fully typing the interface and generating the docs from the annotations. Python's type system feels like a toy at times like this. How do we ensure that a
DataGranules
method exists for each parameter on thesearch_data
interface? Maybe we should instead collect the parameter methods in a dict? Just thinking out loud.The text was updated successfully, but these errors were encountered: