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 common alias perspective (p) for plotting 3D illustrations #627

Merged
merged 2 commits into from
Sep 21, 2020

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented Sep 21, 2020

Description of proposed changes

Used to select a perspective view by setting the azimuth and elevation angle of the viewpoint. See https://docs.generic-mapping-tools.org/6.1/gmt.html#perspective-full.

perspective minimal docs with link to gmt manpage

Live documentation preview for this PR/branch is at https://pygmt-git-common-aliases-p.gmt.vercel.app/api/generated/pygmt.Figure.plot.html

Note that the 'perspective' name follows the upstream GMT long option name convention at https://github.com/GenericMappingTools/gmt/blob/88421f9f8fe9759692302905268f4036b287adcb/src/gmt_init.c#L408

This PR will be a part of #620 too.

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.

@weiji14 weiji14 added the documentation Improvements or additions to documentation label Sep 21, 2020
@weiji14 weiji14 added this to the 0.2.1 milestone Sep 21, 2020
@weiji14 weiji14 mentioned this pull request Sep 21, 2020
24 tasks
@weiji14
Copy link
Member Author

weiji14 commented Sep 21, 2020

Cool, thanks for reviewing this series of 'common alias' PRs @seisman! This should be one of the last important ones at https://docs.generic-mapping-tools.org/6.1/std-opts.html to be handled. There's still -c but that will be done in the subplot wrapper.

@weiji14 weiji14 merged commit 56ba083 into master Sep 21, 2020
@weiji14 weiji14 deleted the common-aliases/p branch September 21, 2020 05:39
@weiji14 weiji14 mentioned this pull request Oct 23, 2020
28 tasks
@weiji14 weiji14 mentioned this pull request Nov 6, 2020
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.

2 participants