Skip to content

Figure.meca: Expand docstrings for "compressionfill", "cmap", and "offset" #2553

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

Merged
merged 5 commits into from
Jun 1, 2023
Merged

Figure.meca: Expand docstrings for "compressionfill", "cmap", and "offset" #2553

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7fc0757
Expand docstrings for 'compressionfill' and 'offset' regarding fill o…
yvonnefroehlich May 30, 2023
6f0359a
Expand docstrings for 'cmap' and 'offset' regarding fill of circle
yvonnefroehlich May 30, 2023
de1c068
Fix word order
yvonnefroehlich May 31, 2023
11030fd
Fix word order
yvonnefroehlich May 31, 2023
9ce2f52
Merge branch 'main' into expand-meca-docs-compressionfill-offset
yvonnefroehlich May 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions pygmt/src/meca.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,10 +214,13 @@ def meca(
is plotted at the initial location and a line connects the beachball
to the circle. Use **+s**\ *size* to set the diameter of the circle
[Default is no circle]. Use **+p**\ *pen* to set the line pen
attributes [Default is ``"0.25p"``].
attributes [Default is ``"0.25p"``]. The fill of the circle is set
via ``compressionfill`` or ``cmap``, i.e., corresponds to the fill
of the compressive quadrants.
compressionfill : str
Set color or pattern for filling compressive quadrants
[Default is ``"black"``].
[Default is ``"black"``]. This setting also applies to the fill of
the circle defined via ``offset``.
extensionfill : str
Set color or pattern for filling extensive quadrants
[Default is ``"white"``].
Expand All @@ -229,7 +232,8 @@ def meca(
*color1,color2,color3*) to build a linear continuous CPT from those
colors automatically. The color of the compressive quadrants is
determined by the z-value (i.e., event depth or the third column for
an input file).
an input file). This setting also applies to the fill of the circle
defined via ``offset``.
no_clip : bool
Do **not** skip symbols that fall outside the frame boundaries
[Default is ``False``, i.e., plot symbols inside the frame
Expand Down