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.

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

Check and fix all docstrings #19

Closed
einbandi opened this issue Jul 13, 2022 · 2 comments
Closed

Check and fix all docstrings #19

einbandi opened this issue Jul 13, 2022 · 2 comments

Comments

@einbandi
Copy link
Collaborator

Things to consider:

  • Add :class:, :meth:, etc. specifiers.
  • Check indentation, especially in argument lists.
  • Check again what the best practices are for type information.
  • Check if methods use third person.
@einbandi
Copy link
Collaborator Author

Class versions of relation conversion methods hsould have same docstrings as functional ones.

@einbandi
Copy link
Collaborator Author

einbandi commented Jul 21, 2022

  • exceptions.py
  • loss.py
  • models.py
  • paradime.py
  • relationdata.py
  • relations.py
  • transforms.py
  • utils.py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant