Skip to content

DOC: Add Pattern to the type hints of fill-related parameters - #4902

Open
seisman wants to merge 2 commits into
mainfrom
doc/pattern
Open

seisman wants to merge 2 commits into
mainfrom
doc/pattern

Conversation

@seisman

@seisman seisman commented Sep 20, 2026

Copy link
Copy Markdown
Member

fill and similar parameters should accept Pattern.

@seisman seisman added this to the 0.20.0 milestone Sep 20, 2026
@seisman seisman added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog final review call This PR requires final review and approval from a second reviewer labels Sep 20, 2026
Comment on lines -8 to -20
Example method parameters that support bit and hachure patterns include:

- :meth:`pygmt.Figure.coast`: Land and water masses via ``land`` and ``water``
- :meth:`pygmt.Figure.histogram`: Histogram bars via ``fill``
- :meth:`pygmt.Figure.meca`: Focal mechanisms via ``compression_fill`` and
``extension_fill``
- :meth:`pygmt.Figure.plot`: Symbols and polygons via ``fill``
- :meth:`pygmt.Figure.rose`: Histogram sectors via ``fill``
- :meth:`pygmt.Figure.solar`: Day-light terminators via ``fill``
- :meth:`pygmt.Figure.ternary`: Symbols via ``fill``
- :meth:`pygmt.Figure.velo`: Uncertainty wedges and velocity error ellipses via
``uncertainty_fill``
- :meth:`pygmt.Figure.wiggle`: Anomalies via ``positive_fill`` and ``negative_fill``

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.

As any fill-like parameters accept Pattern, I feel it makes little sense to list so many plotting methods here.

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 final review call This PR requires final review and approval from a second reviewer skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant