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

minor docs improvements #386

Merged
merged 3 commits into from
Dec 23, 2019
Merged

minor docs improvements #386

merged 3 commits into from
Dec 23, 2019

Conversation

kmaterna
Copy link
Contributor

First ever pull request! I've been using pygmt and it's great- thanks for making it.
I found a few minor points in the docs that would hopefully clarify "coast" and "-B" in my experience.

B can be repeated in GMT, but I found it confusing to learn how to repeat -B in pygmt (eventually found it in the Note for Experienced GMT Users). This change to the documentation would help clarify the confusion.
I accidentally found that -L works in coast as well as basemap. It would help to have this in the docs.
@welcome
Copy link

welcome bot commented Dec 19, 2019

💖 Thanks for opening this pull request! 💖

Please make sure you read our contributing guidelines and abide by our code of conduct.

A few things to keep in mind:

  • 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! 🎉

Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Hi @kmaterna, thanks for opening this Pull Request! I just have one minor suggestion (add an alias for L in coast), otherwise it looks good. Let me know If there's any other related improvements you'd like to add, and I'll wait for those before merging this PR in 😄

pygmt/base_plotting.py Show resolved Hide resolved
pygmt/helpers/decorators.py Show resolved Hide resolved
pygmt/base_plotting.py Outdated Show resolved Hide resolved
@weiji14 weiji14 merged commit 2bc5f7d into GenericMappingTools:master Dec 23, 2019
@welcome
Copy link

welcome bot commented Dec 23, 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.

@weiji14
Copy link
Member

weiji14 commented Dec 23, 2019

Thanks @kmaterna! Feel free to point out any other things in the documentation you'd like to improve, or new features you'd like to see in the future. Pull requests like this are always very welcome 😃

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