Skip to content

Improve documentation of Figure.logo()#651

Merged
seisman merged 2 commits intomasterfrom
improve-logo
Oct 16, 2020
Merged

Improve documentation of Figure.logo()#651
seisman merged 2 commits intomasterfrom
improve-logo

Conversation

@seisman
Copy link
Member

@seisman seisman commented Oct 16, 2020 •
edited
Loading

Description of proposed changes

  • Fix a broken link to gmtlogo documentation
  • Add option -V
  • Remove option -p (not listed in the documentation)
  • Add option -S (new in GMT 6.0)
  • Option -D is no longer required (tested with GMT>=6.1.1)
  • Remove the test for -D

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 docstrings or tutorials.

@seisman
Improve documentation of Figure.logo()
6411f15 
- Fix a broken link to gmtlogo documentation
- Add option **-V**
- Remove option **-p** (not listed in the documentation)
- Add option **-S** (new in GMT 6.0)
- Option **-D** is no longer required (tested with GMT>=6.1.1)
- Remove the test for **-D**
@seisman seisman added the documentation Improvements or additions to documentation label Oct 16, 2020
@seisman seisman added this to the 0.2.1 milestone Oct 16, 2020
@seisman seisman requested a review from weiji14 October 16, 2020 01:38
weiji14
weiji14 reviewed Oct 16, 2020
View reviewed changes
@seisman @weiji14
Update pygmt/base_plotting.py
3c62baf 
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@seisman
Copy link
Member Author

seisman commented Oct 16, 2020 •
edited
Loading

In addition to the standard GMT options, GMT.jl also provides two more arguments julia and GMTjulia, which can plot Julia and GMT.jl logos, respectively. https://www.generic-mapping-tools.org/GMT.jl/latest/#GMT.logo

This sounds an interesting feature, and we may provide the pygmt argument to plot a PyGMT logo in the future.

@weiji14
Copy link
Member

weiji14 commented Oct 16, 2020

In addition to the standard GMT options, GMT.jl also provides two more arguments julia and GMTjulia, which can plot Julia and GMT.jl logos, respectively. https://www.generic-mapping-tools.org/GMT.jl/latest/#GMT.logo

This sounds an interesting feature, and we may provide the pygmt argument to plot a PyGMT logo in the future.

Yes! I've thought about making a PyGMT logo before. Let's open up an issue and we can make a call for contributions 😄

@seisman seisman merged commit e230308 into master Oct 16, 2020
@seisman seisman deleted the improve-logo branch October 16, 2020 02:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@weiji14 weiji14 weiji14 approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

0.2.1

Development

Successfully merging this pull request may close these issues.

2 participants

@seisman @weiji14