add OGC API - EDR client #899
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
huard
approved these changes
Dec 18, 2023
|
|
||
| def __init__(self, url: str, json_: str = None, timeout: int = 30, | ||
| headers: dict = None, auth: Authentication = None): | ||
| __doc__ = Features.__doc__ # noqa |
There was a problem hiding this comment.
Isn't there a need for a custom docstring ?
There was a problem hiding this comment.
Not at this level, given the building blocks of OGC APIs (collections are the same across APIS). docstrings are more specific deeper into the endpoints.
|
|
||
| def data(self) -> list: | ||
| """ | ||
| implements /collections filtered on EDR data resources |
There was a problem hiding this comment.
Suggested change
| implements /collections filtered on EDR data resources | |
| Collections filtered on EDR data resources. |
| def query_data(self, collection_id: str, | ||
| query_type: str, **kwargs: dict) -> BinaryIO: | ||
| """ | ||
| implements /collection/{collectionId}/coverage/ |
There was a problem hiding this comment.
From someone who's not familiar with the API, I suggest the docstring should start with what the function does in simple terms.
There was a problem hiding this comment.
All owslib.ogcapi is documented in this manner (and much of owslib). I can cover this more fully in a subsequent PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
FYI this PR should be merged once the pygeoapi demo server is updated via this PR.