Wrap inset by willschlitzer · Pull Request #788 · GenericMappingTools/pygmt

willschlitzer · 2021-01-03T11:47:40Z

Description of proposed changes

As discussed in #663, this is wrapping the GMT function inset. After some back and forth (and an attempt at Option 2), this PR goes with Option 1 to use a context manager and with statement to call inset.

Fixes#663

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.

Notes

You can write /format in the first line of a comment to lint the code automatically

…ng.py

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

weiji14

Fingers crossed that we can finalize this before the PyGMT meeting!

seisman · 2021-02-05T07:55:20Z

The PR looks good to me after addressing the above minor comments.

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

weiji14

Phew, thanks for your patience @willschlitzer. Feel free to merge once the tests pass! 🚀

*Wrap inset function to use a context manager *Create src/inset.py and import inset function into base_plotting.py Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com> Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

willschlitzer added 3 commits January 3, 2021 10:58

Add inset_begin() and inset_end() to base_plotting.py
b7eb160

Fix inset kwargs decorator
b2b0221

Update docstrings for inset_begin() in base_plotting.py
7bc6718

vercelBottemporarily deployed to Preview January 3, 2021 11:47 Inactive

willschlitzer added 2 commits January 3, 2021 12:04

Update API index for inset_begin() and inset_end()
f77c4d0

Update location parameter explanation on inset_begin() in base_plotti…
4d12ee6
…ng.py

vercelBottemporarily deployed to Preview January 3, 2021 12:09 Inactive

willschlitzer added 5 commits January 3, 2021 12:17

Format inset_begin docstring to 79 character line limit
63795b7

Wording in inset_begin docstring
253a0c6

Adding line break in docstring
11225e5

Add margin and border doc strings for inset_begin() in base_plotting
8473286

Add verbose alias to parameter list in inset_begin()
27fc16c

vercelBottemporarily deployed to Preview January 3, 2021 12:50 Inactive

willschlitzer added 2 commits January 3, 2021 13:00

Update doc string for inset_begin() in base_plotting.py
72edffd

Splitting up parameter headings in inset_begin()
934b75e

vercelBottemporarily deployed to Preview January 3, 2021 13:04 Inactive

Add test_inset.py
526abf0

vercelBottemporarily deployed to Preview January 3, 2021 13:29 Inactive

Removing parameter heading breakdown for inset_begin
d720a57

vercelBottemporarily deployed to Preview January 3, 2021 13:39 Inactive

willschlitzer added the feature Brand new feature label Jan 3, 2021

willschlitzer added this to the 0.3.0 milestone Jan 3, 2021

Fix test
983bb53

vercelBottemporarily deployed to Preview January 3, 2021 14:50 Inactive

willschlitzer added 6 commits January 3, 2021 14:52

Use aliases for both instances of Figure.coast() in test_inset_aliases()
db9fb9d

Run make format
4fead4c

Add test_inset_end() to test_inset.py
610fdee

Add test_inset_end_requirement() to test_inset.py
f1548c3

Update doc string for inset_end() in base_plotting.py
e479416

Merge branch 'master' into wrap-inset
8e3729b

seisman reviewed Feb 4, 2021
View reviewed changes

Comment threadpygmt/base_plotting.py

weiji14 mentioned this pull request Feb 4, 2021
Move plotting functions to separate modules #808
Merged
2 tasks

seisman reviewed Feb 4, 2021
View reviewed changes

Comment threadpygmt/src/inset.py Outdated

seisman reviewed Feb 4, 2021
View reviewed changes

Comment threadpygmt/src/__init__.py Outdated

seisman reviewed Feb 4, 2021
View reviewed changes

Apply suggestions from code review
ba47788
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

vercelBottemporarily deployed to Preview February 5, 2021 06:51 Inactive

willschlitzerand others added 3 commits February 5, 2021 06:52

Apply suggestions from code review
96df4a8
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Remove supplementary module comment
37705dc

Move pylint comment to top of src/__init__.py
276840e

vercelBottemporarily deployed to Preview February 5, 2021 06:57 Inactive

weiji14 reviewed Feb 5, 2021
View reviewed changes

Comment threadpygmt/src/inset.py
Comment threadpygmt/src/inset.py Outdated
Comment threadpygmt/src/inset.py Outdated

seisman reviewed Feb 5, 2021
View reviewed changes

Comment threadexamples/gallery/plot/inset.py Outdated
Comment threadexamples/gallery/plot/inset.py
Comment threadexamples/tutorials/inset.py

Update examples/gallery/plot/inset.py
717e404
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

vercelBottemporarily deployed to Preview February 5, 2021 09:38 Inactive

willschlitzerand others added 5 commits February 5, 2021 09:38

Update pygmt/src/inset.py
687ffb5
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

Update pygmt/src/inset.py
741b770
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

Update pygmt/src/inset.py
7c16b75
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

Update examples/gallery/plot/inset.py
7839399
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update examples/tutorials/inset.py
716c03d
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

vercelBottemporarily deployed to Preview February 5, 2021 09:43 Inactive

Fix inset end -V
91d83fd

vercelBottemporarily deployed to Preview February 5, 2021 09:53 Inactive

weiji14 approved these changes Feb 5, 2021
View reviewed changes

willschlitzer merged commit 12adb41 into GenericMappingTools:masterFeb 5, 2021

seisman mentioned this pull request Feb 6, 2021
An inset bug GenericMappingTools/gmt#4757
Closed

willschlitzer deleted the wrap-inset branch February 6, 2021 09:45

seisman mentioned this pull request Jan 18, 2026
Figure.inset: Manage figure inset setup and completion #4250
Closed
9 tasks

Navigation Menu

Uh oh!

Wrap inset - #788

Wrap inset#788
willschlitzer merged 81 commits into
GenericMappingTools:masterfrom
willschlitzer:wrap-inset

willschlitzer commented Jan 3, 2021•
edited
Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

weiji14 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman commented Feb 5, 2021

Uh oh!

weiji14 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

willschlitzer commented Jan 3, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

weiji14 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman commented Feb 5, 2021

Uh oh!

weiji14 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

willschlitzer commented Jan 3, 2021•
edited
Loading