-
Notifications
You must be signed in to change notification settings - Fork 44
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
docs: plugins and utils documention update #1297
docs: plugins and utils documention update #1297
Conversation
Code Coverage (Ubuntu)
Diff against develop
Results for commit: 6bb304e Minimum allowed coverage is ♻️ This comment has been updated with latest results |
Code Coverage (Windows)
Diff against develop
Results for commit: 6bb304e Minimum allowed coverage is ♻️ This comment has been updated with latest results |
4215f14
to
d6fc761
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please edit docstrings layout, following HttpDownload
, QueryStringSearch
and ODataV4Search
models:
- describe config parameters inside
config
parameter description - link parameters to their
PluginConfig
class variable - if
PluginConfig
class variable (attribute ou TypedDict) is missing, add it
format of documentation for config parameters changed to sphinx style |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Also fix rst formatting in
api/base
f7322b1
to
5ee5d15
Compare
First part of comments is implemented, I will check the rest later. |
Code Coverage (Ubuntu)
Diff against develop
Results for commit: c7cd7ed Minimum allowed coverage is ♻️ This comment has been updated with latest results |
Code Coverage (Windows)
Diff against develop
Results for commit: c7cd7ed Minimum allowed coverage is ♻️ This comment has been updated with latest results |
b457532
to
75a6aa7
Compare
75a6aa7
to
c7cd7ed
Compare
eodag.utils
functions included in documentationNOTE: for currently unused plugins (such as
CSWSearch
orS3RestDownload
) the documentation might be incomplete due to missing examples; it should be updated when they are used again