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

Add description for the "columns" arguments #766

Merged
merged 6 commits into from
Dec 27, 2020

Conversation

michaelgrund
Copy link
Member

@michaelgrund michaelgrund commented Dec 26, 2020

Add missing description for the columns argument in Figure.plot.

Closes #764.

@welcome
Copy link

welcome bot commented Dec 26, 2020

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

@michaelgrund
Copy link
Member Author

/format

1 similar comment
@seisman
Copy link
Member

seisman commented Dec 26, 2020

/format

pygmt/base_plotting.py Outdated Show resolved Hide resolved
pygmt/base_plotting.py Outdated Show resolved Hide resolved
@seisman
Copy link
Member

seisman commented Dec 26, 2020

@michaelgrund Thanks for your PR.

Your /format command doesn't work due to a bug (#767), and I will try to fix it later.

I just made two tiny comments about your changes. Besides that, you also need to manually limit the docstrings to no more than 80 characters per line to fix these styling issues:

flake8 pygmt setup.py doc/conf.py
pygmt/base_plotting.py:786:80: W505 doc line too long (81 > 79 characters)
pygmt/base_plotting.py:787:80: W505 doc line too long (85 > 79 characters)
pygmt/base_plotting.py:788:80: W505 doc line too long (82 > 79 characters)
make: *** [check] Error 1
Makefile:44: recipe for target 'check' failed

@seisman seisman added the documentation Improvements or additions to documentation label Dec 26, 2020
@seisman seisman added this to the 0.3.0 milestone Dec 26, 2020
@michaelgrund
Copy link
Member Author

@michaelgrund Thanks for your PR.

Your /format command doesn't work due to a bug (#767), and I will try to fix it later.

I just made two tiny comments about your changes. Besides that, you also need to manually limit the docstrings to no more than 80 characters per line to fix these styling issues:

flake8 pygmt setup.py doc/conf.py
pygmt/base_plotting.py:786:80: W505 doc line too long (81 > 79 characters)
pygmt/base_plotting.py:787:80: W505 doc line too long (85 > 79 characters)
pygmt/base_plotting.py:788:80: W505 doc line too long (82 > 79 characters)
make: *** [check] Error 1
Makefile:44: recipe for target 'check' failed

Thanks for fixing it. Totally read over docstrings limit, good to know for next time ;)

@seisman seisman changed the title Update base_plotting.py Add description for the "columns" arguments Dec 26, 2020
pygmt/base_plotting.py Outdated Show resolved Hide resolved
@seisman
Copy link
Member

seisman commented Dec 27, 2020

/format

@seisman seisman merged commit f7c930a into GenericMappingTools:master Dec 27, 2020
@welcome
Copy link

welcome bot commented Dec 27, 2020

🎉🎉🎉 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.

@michaelgrund michaelgrund deleted the patch-1 branch January 20, 2021 07:27
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Description for the "columns" arguments is missing
3 participants