Skip to content

DOC: Improve the description of the -p option - #9142

Open
seisman wants to merge 2 commits into
masterfrom
doc/perspective
Open

DOC: Improve the description of the -p option#9142
seisman wants to merge 2 commits into
masterfrom
doc/perspective

Conversation

@seisman

@seisman seisman commented Aug 24, 2026

Copy link
Copy Markdown
Member

When wrapping the -p option in PyGMT, I feel the -p documentation is confusing and misleading. This PR improves it.

See GenericMappingTools/pygmt#4176 (comment) for a related test to understand the behavior.

- */zlevel* to indicate the z-level at which all 2D material, like the plot frame, is plotted (only valid when **-p**
is used in consort with **-Jz** or **-JZ**) [Default is at the bottom of the z-axis].

For frames used for animation, we fix the center of your data domain. Specify another center using one of the following

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This sentence gives me the wrong impression that +w/+v only works for animations.

different point instead, given in either data or plot coordinates, with one of the following modifiers:

- **+w** - Project *lon0*/*lat0* (and *z0* if applicable) to the center of the page size.
- **+v** - Specify the coordinates of the projected 2-D view point as *x0*/*y0*.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

"The center of the page size" is very confusing.

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.

1 participant