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

Clean up the docstring of the main methods/classes #241

Closed
3 tasks done
maximlt opened this issue Apr 20, 2021 · 0 comments · Fixed by #355
Closed
3 tasks done

Clean up the docstring of the main methods/classes #241

maximlt opened this issue Apr 20, 2021 · 0 comments · Fixed by #355
Assignees
@CGuichard
Labels
documentation Improvements or additions to documentation
Projects
eodag.*

Comments

@maximlt
Copy link
Collaborator

maximlt commented Apr 20, 2021 •
edited by CGuichard
Loading

  • Remove doctests when they make the method's docstring more difficult to understand
  • Remove old versionadded or versionchanged directives, they are not useful for the users and we have the changelog to trace those changes
  • Update the description and type of the parameters when need be
@maximlt maximlt added the documentation Improvements or additions to documentation label Apr 20, 2021
@sbrunato sbrunato added this to Low Priority in eodag.* Apr 21, 2021
@sbrunato sbrunato moved this from priority::1 to To Do in eodag.* Aug 17, 2021
CGuichard added a commit that referenced this issue Oct 27, 2021
@CGuichard
docs: remove versionadded and versionchanged directives from docstrin…
31213ae 
…gs (#241)
CGuichard added a commit that referenced this issue Oct 27, 2021
@CGuichard
docs: cleanup and update of docstrings (#241)
27536dc
@CGuichard CGuichard mentioned this issue Oct 27, 2021
Merged
CGuichard added a commit that referenced this issue Oct 27, 2021
@CGuichard
docs: cleanup and update of docstrings (#241)
312514d
CGuichard added a commit that referenced this issue Oct 28, 2021
@CGuichard
docs: cleanup and update of docstrings (#241)
698af76
CGuichard added a commit that referenced this issue Nov 2, 2021
@CGuichard
docs: cleanup and update of docstrings (#241)
5196e61
@CGuichard CGuichard moved this from To Do to In Progress in eodag.* Nov 4, 2021
CGuichard added a commit that referenced this issue Nov 10, 2021
@CGuichard
docs: cleanup and update of docstrings (#241)
240f0af
eodag.* automation moved this from In Progress to Done Nov 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@CGuichard CGuichard

Labels
documentation Improvements or additions to documentation
Projects
No open projects
eodag.*
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docstring cleanup CS-SI/eodag
3 participants
@CGuichard @maximlt @sbrunato