search_data & search_datasets documentation parameter list is incomplete

[mfisher87]

• The docstring for search_data includes undocumented parameter cloud_hosted in its example.
• downloadable parameter is not documented.
• I think there are others, but I don't have time to be exhaustive at the moment :)

Currently, kwargs are passed from search_data to a DataGranules object's parameters method, which also accepts kwargs. The possible keys are fixed by the methods on DataGranules, and populated dynamically by matching keys to method names.

earthaccess/earthaccess/api.py

Lines 116 to 119 in ff0c59a

	if earthaccess.__auth__.authenticated:
	query = DataGranules(earthaccess.__auth__).parameters(**kwargs)
	else:
	query = DataGranules().parameters(**kwargs)

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 the search_data interface? Maybe we should instead collect the parameter methods in a dict? Just thinking out loud.

[andypbarrett]

I am currently working on updating the earthaccess docs. My focus is on the "Getting Started", "User Guide" and "How Tos". I can think about how we can do this as part of my doc work, so I'll assign it to myself. But it seems like this API documentation might be automated, I will need to learn about this.

[paolodep36]

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

[MattF-NSIDC]

Hey @paolodep36, thanks for posting your question! Is there a specific parameter you're expecting to see in the docs for search_data()? If not, let's move your question to another place so we can focus on it better:

• If you think you have a bug on your hands (or would like to request a new feature), can you please open a new issue?

• If you're looking for more general support (i.e. you aren't sure whether you found a bug or need help), can you please post on our Q&A discussion board?

[mfisher87]

More confusion that I think comes from this docs problem: #478

In this case the undocumented parameter was point.

[mfisher87]

More pain for our users: #504 (comment)

I'm going to pin this.