Skip to content

Conversation

Opt-Mucca
Copy link
Collaborator

What was done in this MR:

  • Unified docstring style to numpydoc
  • Added missing information on parameters to docstring where appropriate
  • Add new style of showing the API to the online documentation.

What I did not do:

  • Change the docstrings of all tests + other pieces of code. I think much of this will come from implementing a style formatter.
  • I did not add type hints. If anything I removed the few that we had. Guides online suggest that they are redundant if the docstrings are done properly. IDEs should now be able to extract the types for all parameters for instance. Implementing type hints in Cython is also different than standard Python. For instance, mypy requires an additional file with each function declaration.

Copy link
Member

@Joao-Dionisio Joao-Dionisio left a comment

Choose a reason for hiding this comment

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

My god Mark. I don't even know what to say. Just reviewing this took a bunch of time, I can't imagine what it was like for you ahah. Just these minor typos, most of which were already there

I'll commit the suggestions that are clearly correct.

Opt-Mucca and others added 23 commits September 23, 2024 11:31
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
Co-authored-by: João Dionísio <57299939+Joao-Dionisio@users.noreply.github.com>
@Opt-Mucca
Copy link
Collaborator Author

@Joao-Dionisio I didn't expect such a robust review. So I'm not sure if I even spent that much more time comparatively.
All the changes should be addressed now! Thank you for fixing a lot of the small errors.

@Joao-Dionisio Joao-Dionisio merged commit 729420c into master Sep 23, 2024
1 check passed
@Joao-Dionisio Joao-Dionisio deleted the mt/docstring_change branch April 22, 2025 17:59
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

Successfully merging this pull request may close these issues.

3 participants