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

Replace "gravity" by "gravitational" in documentation #117

Merged
merged 2 commits into from
Oct 25, 2019

Conversation

birocoles
Copy link
Member

The functions point_mass_gravity, prism_gravity and tesseroid_gravity compute components of the gravitational field (and not the gravity field) produced by point massas, rectangular prisms and tesseroids, respectively. Hence, I have replaced the term "gravity" by "gravitational" in the documentation of these functions.

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.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.

Copy link
Member

@leouieda leouieda left a comment

Choose a reason for hiding this comment

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

👍 thanks, @birocoles! Sorry for the trouble. Keep them coming!

@leouieda leouieda merged commit b25b9b9 into fatiando:master Oct 25, 2019
@welcome
Copy link

welcome bot commented Oct 25, 2019

🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉

Please open a new pull request to add yourself to the AUTHORS.md file. We hope that this was a good experience for you. Let us know if there is any way that the contributing process could be improved.

birocoles added a commit to birocoles/harmonica that referenced this pull request Nov 1, 2019
Replace gravity with gravitational in docstrings (fatiando#117)
@birocoles birocoles deleted the gravity-gravitational branch November 1, 2019 13:40
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