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.

Sign up for GitHub

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

Jump to bottom

Add common alias transparency (-t) to all plotting functions #614

Merged
merged 3 commits into from
Sep 17, 2020
Merged

Add common alias transparency (-t) to all plotting functions #614

merged 3 commits into from
Sep 17, 2020

Conversation

seisman
Copy link
Member

@seisman seisman commented Sep 17, 2020 •
edited
Loading

Description of proposed changes

Add transparency (alias of -t option) to all plotting modules.

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
seisman commented Sep 17, 2020
View reviewed changes
pygmt/helpers/decorators.py
@@ -82,6 +82,13 @@
``[g|p]``
Force output grid to be gridline (g) or pixel (p) node registered.
Default is gridline (g).""",
"t": """\
transparency : float
Copy link
Member Author

@seisman seisman Sep 17, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

transparency can also be an array for a few modules, e.g., plot, plot3d and text, so that symbols and texts can have varying transparency. It needs more work and should be addressed in separated PRs.

I will open a feature request after merging this PR.

Copy link
Member

Choose a reason for hiding this comment

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

Ok, but could you add at least one unit test for transparency on a module that won't have array-like transparency inputs (e.g. image)?

Copy link
Member Author

Choose a reason for hiding this comment

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

It means adding another baseline image to the repository. 😄

Copy link
Member

Choose a reason for hiding this comment

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

Maybe just a gallery example then, if not too much work 😶 I suppose we could come up with a smart check_figures_equal test but happy to leave that to the next PR.

Copy link
Member Author

Choose a reason for hiding this comment

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

There is an upcoming example in #607, but I'm not sure if the example does too many things (symbols, transparency and legends.).

Copy link
Member

Choose a reason for hiding this comment

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

Ah right, missed the transparency part on that example. I don't think we can have too many examples, if anything we have too little right now (a lot of catching up to do with matplotlib at https://matplotlib.org/gallery/index.html)!

@seisman seisman changed the title Add alias -t (transparency) for all plotting functions Add alias -t (transparency) to all plotting functions Sep 17, 2020
@seisman seisman added the enhancement Improving an existing feature label Sep 17, 2020
@seisman seisman added this to the 0.2.1 milestone Sep 17, 2020
@seisman seisman requested a review from weiji14 September 17, 2020 22:00
weiji14
weiji14 reviewed Sep 17, 2020
View reviewed changes
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.

Cool, I haven't actually used transparency before, but looks fine. An example would be nice 😉

pygmt/helpers/decorators.py
@@ -82,6 +82,13 @@
``[g|p]``
Force output grid to be gridline (g) or pixel (p) node registered.
Default is gridline (g).""",
"t": """\
transparency : float
Copy link
Member

Choose a reason for hiding this comment

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

Ok, but could you add at least one unit test for transparency on a module that won't have array-like transparency inputs (e.g. image)?

pygmt/helpers/decorators.py Outdated Show resolved Hide resolved
@seisman seisman merged commit 4e4dbbc into master Sep 17, 2020
@seisman seisman deleted the t-alias branch September 17, 2020 22:42
@seisman seisman changed the title Add alias -t (transparency) to all plotting functions Add common alias transparency (-t) to all plotting functions Sep 17, 2020
@seisman seisman mentioned this pull request Sep 18, 2020
Closed
@weiji14 weiji14 mentioned this pull request Sep 20, 2020
Closed
@seisman seisman mentioned this pull request Sep 27, 2020
Merged
8 tasks
@seisman seisman added documentation Improvements or additions to documentation and removed enhancement Improving an existing feature labels Oct 5, 2020
@weiji14 weiji14 mentioned this pull request Oct 23, 2020
Merged
28 tasks
@weiji14 weiji14 mentioned this pull request Nov 6, 2020
Merged
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