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

Fix typos in docstrings #303

Merged
merged 2 commits into from
Nov 30, 2020
Merged

Fix typos in docstrings #303

merged 2 commits into from
Nov 30, 2020

Conversation

dcslagel
Copy link
Contributor

@dcslagel dcslagel commented Nov 28, 2020

Description:

This pull-request Fixes #287. It cherry-picks jcrawfords original work on this (seen in unmerged/closed pr #288) and adds the change requested by santisoler (in pr #288).

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.

Let me know if this change could be accepted (or rejected) or needs some additional changes to be approved and merged.

Thank you,
DC Slagel

@welcome
Copy link

welcome bot commented Nov 28, 2020

💖 Thanks for opening your first pull request! 💖

Please make sure you read the following:

  • Authorship Guidelines: Our rules for giving you credit for your contributions, including authorship on publications and Zenodo archives.
  • Contributing Guide: What the review process is like and our infrastructure for testing and documentation.
  • Code of Conduct: How we expect people to interact in our projects.

A few things to keep in mind:

  • Remember to run make format to make sure your code follows our style guide.
  • If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
  • All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
  • No matter what, we are really grateful that you put in the effort to do this! ⭐

@leouieda leouieda merged commit 06a74a4 into fatiando:master Nov 30, 2020
@welcome
Copy link

welcome bot commented Nov 30, 2020

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

If you would like to be added as a author on the Zenodo archive of the next release, make sure that you have added your full name, affiliation, and ORCID (optional) to the AUTHORS.md file of this repository.

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.

@leouieda
Copy link
Member

Thanks @dcslagel! Much appreciated 👍🏽 It's really nice that you cherrypicked the original commits 🙂

@dcslagel dcslagel deleted the fix-typos-in-docstrings branch November 30, 2020 14:01
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.

Fix typos on docstrings
3 participants