Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Docstring cleanup #355

Merged
merged 2 commits into from
Nov 10, 2021
Merged

Docstring cleanup #355

merged 2 commits into from
Nov 10, 2021

Conversation

CGuichard
Copy link
Collaborator

Fixes #241.

Docstrings modifications :

  • Removes versionadded and versionchanged directives from docstrings.
  • Unifies use of :param <name>: and :type <type>:, because it was sometimes in the form :param <type> <name>:.
  • Adds missing (optional).
  • Both :returns: and :return: have been used, but the latter has been used less and has therefore been replaced by the former.
  • The description of the parameters started mainly with an uppercase letter, those starting with a lowercase were corrected.
  • Other minor fixes...

@CGuichard CGuichard force-pushed the docstring_cleanup branch 3 times, most recently from 698af76 to 5196e61 Compare November 2, 2021 16:15
sbrunato
sbrunato reviewed Nov 9, 2021
View reviewed changes
Copy link
Collaborator

@sbrunato sbrunato left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are just RST formatting small issues: see
docs/readthedocs.org:eodag details in PR checks for a documentation preview

eodag/plugins/crunch/filter_date.py Outdated Show resolved Hide resolved
eodag/plugins/crunch/filter_overlap.py Outdated Show resolved Hide resolved
eodag/plugins/crunch/filter_latest_tpl_name.py Outdated Show resolved Hide resolved
eodag/plugins/crunch/filter_property.py Outdated Show resolved Hide resolved
@sbrunato sbrunato merged commit 70aa455 into develop Nov 10, 2021
@sbrunato sbrunato deleted the docstring_cleanup branch November 10, 2021 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sbrunato sbrunato sbrunato approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Clean up the docstring of the main methods/classes
2 participants
@CGuichard @sbrunato