Skip to content

Add legend gallery entry#358

Merged
weiji14 merged 5 commits intoGenericMappingTools:masterfrom
liamtoney:legend-gallery
Nov 1, 2019
Merged

Add legend gallery entry#358
weiji14 merged 5 commits intoGenericMappingTools:masterfrom
liamtoney:legend-gallery

Conversation

@liamtoney
Copy link
Member

@liamtoney liamtoney commented Nov 1, 2019

Description of proposed changes

Just adding a legend example to the gallery.

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.

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.

I'm thinking whether we should combine the colorbar and legend examples into a full tutorial, considering that the position justification, offset and lots of things are similar. But let's keep it simple for now.

Co-Authored-By: Wei Ji <23487320+weiji14@users.noreply.github.com>
@vercel vercel bot temporarily deployed to staging November 1, 2019 08:23 Inactive
Co-Authored-By: Wei Ji <23487320+weiji14@users.noreply.github.com>
@vercel vercel bot temporarily deployed to staging November 1, 2019 08:24 Inactive
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.

Ok, I'll approve this, but I noticed that the legend docstring at https://www.pygmt.org/dev/api/generated/pygmt.Figure.legend.html has this text

b) a list containing a list of figure handles and a list of corresponding labels.

which I think is a hangover from your regex work 😢 Probably should fix that otherwise people will get confused. You can do that in #359.

@weiji14 weiji14 merged commit af28b9d into GenericMappingTools:master Nov 1, 2019
@liamtoney liamtoney deleted the legend-gallery branch November 1, 2019 17:22
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