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

Improvements to docstrings of Ellipsoid and Sphere #49

Merged
merged 5 commits into from
Oct 8, 2020
Merged

Conversation

leouieda
Copy link
Member

@leouieda leouieda commented Jul 29, 2020

Standardize the docstrings of Sphere and Ellipsoid, add (and fix) missing reference to
Mortiz H. for the mean radius equation, link docstrings of both classes, improve the doc
tests for Sphere.

Reminders:

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
  • Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
  • Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

@leouieda leouieda changed the title WIP Fixes to docstrings of Ellipsoid and Sphere Improvements to docstrings of Ellipsoid and Sphere Oct 8, 2020
Copy link
Member

@santisoler santisoler left a comment

Choose a reason for hiding this comment

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

Now docstrings look way nicer! Thanks!

@leouieda leouieda merged commit 3548a5d into master Oct 8, 2020
@leouieda leouieda deleted the docs-updates branch October 8, 2020 13:36
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.

2 participants