Update parameter 'color' to 'fill' in examples and tutorials #2201

michaelgrund · 2022-11-22T08:00:49Z

Addresses #1617

Description of proposed changes

Fixes #

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 wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

/format: automatically format and lint the code
/test-gmt-dev: run full tests on the latest GMT development version

Addresses #1617

yvonnefroehlich · 2022-11-22T11:06:52Z

Hmm. There seem to be some gallery examples left, which still use the parameter name color (with pygmt.Figure.plot). Or is this renaming split into two or multiple PRs? Probably also some renaming has to be done for the tutorials.

/cygdrive/c/users/Admin/C2/EigeneDokumente/Studium/Promotion/01_GitHub/github_pygmt/pygmt/examples/gallery
$ git branch
  add-colorbars-examples
  fix-alias-list-docs-triangulate
* gallery-color-to-fill
  main
  sphinx-paramlinks

/cygdrive/c/users/Admin/C2/EigeneDokumente/Studium/Promotion/01_GitHub/github_pygmt/pygmt/examples/gallery
$ grep 'color=' */*.py
3d_plots/scatter3d.py:    color=df.species.cat.codes.astype(int),
basemaps/double_y_axes.py:fig.plot(x=x, y=y1, style="c0.2c", color="blue", label="y1")
basemaps/double_y_axes.py:fig.plot(x=x, y=y2, style="s0.28c", color="red", label="y2")
embellishments/legend.py:    color="lightgreen",
embellishments/legend.py:fig.plot(data="@Table_5_11.txt", style="t0.40c", color="orange", label="Oranges")
histograms/blockm.py:    x=data.longitude, y=data.latitude, style="c0.3c", color="white", pen="1p,black"
histograms/blockm.py:    x=data.longitude, y=data.latitude, style="c0.3c", color="white", pen="1p,black"
images/track_sampling.py:    color=(track.bathymetry - track.bathymetry.mean()) / track.bathymetry.std(),
lines/wiggle.py:    color=["red+p", "gray+n"],
seismology/velo_arrow_ellipse.py:    uncertaintycolor="lightblue1",
symbols/bars.py:        fig.plot(x=1, y=2, style="b0.5c", color=color, pen=pen)
symbols/bars.py:        fig.plot(x=2, y=2.5, style="b1c", color=color, pen=pen)
symbols/bars.py:        fig.plot(x=3, y=2.5, style="b0.75c+b1", color=color, pen=pen)
symbols/bars.py:        fig.plot(x=1.5, y=0.5, style="B0.75c", color=color, pen=pen)
symbols/bars.py:        fig.plot(x=3, y=1.5, style="B1c", color=color, pen=pen)
symbols/bars.py:        fig.plot(x=3.5, y=2.5, style="B0.5c+b2", color=color, pen=pen)
symbols/points.py:fig.plot(x=x, y=y, style="i0.5c", color="black")
symbols/points_categorical.py:``color=df.species.cat.codes.astype(int)``. Additionally, we have to set
symbols/points_transparency.py:fig.plot(x=x, y=y, style="c0.6c", color="blue", pen="1p,red", transparency=transparency)
symbols/scatter.py:        color=color,
symbols/text_symbols.py:fig.plot(x=1, y=1.5, style="l3.5c+tA", color="dodgerblue3", pen=pen)
symbols/text_symbols.py:fig.plot(x=2.5, y=1, style="l3.5c+t*", color="red3", pen=pen)
symbols/text_symbols.py:fig.plot(x=4, y=1.5, style="l3.5c+tZ+fCourier-Bold", color="seagreen", pen=pen)
symbols/text_symbols.py:fig.plot(x=5.5, y=1.5, style="l3.5c+ts+fTimes-Italic", color="gold", pen=pen)
symbols/text_symbols.py:fig.plot(x=7, y=1.5, style="l3.5c+t\160+fSymbol,darkorange", color="magenta4", pen=pen)

michaelgrund · 2022-11-22T13:44:17Z

Hmm. There seem to be some gallery examples left, which still use the parameter name color (with pygmt.Figure.plot). Or is this renaming split into two or multiple PRs? Probably also some renaming has to be done for the tutorials.

/cygdrive/c/users/Admin/C2/EigeneDokumente/Studium/Promotion/01_GitHub/github_pygmt/pygmt/examples/gallery
$ git branch
  add-colorbars-examples
  fix-alias-list-docs-triangulate
* gallery-color-to-fill
  main
  sphinx-paramlinks

/cygdrive/c/users/Admin/C2/EigeneDokumente/Studium/Promotion/01_GitHub/github_pygmt/pygmt/examples/gallery
$ grep 'color=' */*.py
3d_plots/scatter3d.py:    color=df.species.cat.codes.astype(int),
basemaps/double_y_axes.py:fig.plot(x=x, y=y1, style="c0.2c", color="blue", label="y1")
basemaps/double_y_axes.py:fig.plot(x=x, y=y2, style="s0.28c", color="red", label="y2")
embellishments/legend.py:    color="lightgreen",
embellishments/legend.py:fig.plot(data="@Table_5_11.txt", style="t0.40c", color="orange", label="Oranges")
histograms/blockm.py:    x=data.longitude, y=data.latitude, style="c0.3c", color="white", pen="1p,black"
histograms/blockm.py:    x=data.longitude, y=data.latitude, style="c0.3c", color="white", pen="1p,black"
images/track_sampling.py:    color=(track.bathymetry - track.bathymetry.mean()) / track.bathymetry.std(),
lines/wiggle.py:    color=["red+p", "gray+n"],
seismology/velo_arrow_ellipse.py:    uncertaintycolor="lightblue1",
symbols/bars.py:        fig.plot(x=1, y=2, style="b0.5c", color=color, pen=pen)
symbols/bars.py:        fig.plot(x=2, y=2.5, style="b1c", color=color, pen=pen)
symbols/bars.py:        fig.plot(x=3, y=2.5, style="b0.75c+b1", color=color, pen=pen)
symbols/bars.py:        fig.plot(x=1.5, y=0.5, style="B0.75c", color=color, pen=pen)
symbols/bars.py:        fig.plot(x=3, y=1.5, style="B1c", color=color, pen=pen)
symbols/bars.py:        fig.plot(x=3.5, y=2.5, style="B0.5c+b2", color=color, pen=pen)
symbols/points.py:fig.plot(x=x, y=y, style="i0.5c", color="black")
symbols/points_categorical.py:``color=df.species.cat.codes.astype(int)``. Additionally, we have to set
symbols/points_transparency.py:fig.plot(x=x, y=y, style="c0.6c", color="blue", pen="1p,red", transparency=transparency)
symbols/scatter.py:        color=color,
symbols/text_symbols.py:fig.plot(x=1, y=1.5, style="l3.5c+tA", color="dodgerblue3", pen=pen)
symbols/text_symbols.py:fig.plot(x=2.5, y=1, style="l3.5c+t*", color="red3", pen=pen)
symbols/text_symbols.py:fig.plot(x=4, y=1.5, style="l3.5c+tZ+fCourier-Bold", color="seagreen", pen=pen)
symbols/text_symbols.py:fig.plot(x=5.5, y=1.5, style="l3.5c+ts+fTimes-Italic", color="gold", pen=pen)
symbols/text_symbols.py:fig.plot(x=7, y=1.5, style="l3.5c+t\160+fSymbol,darkorange", color="magenta4", pen=pen)

This PR is still WIP. Changed it to draft until it's done!

yvonnefroehlich · 2022-11-22T14:36:37Z

This PR is still WIP. Changed it to draft until it's done!

Sounds good 🙂.
I apologize @michaelgrund! Unfortunately, I only looked at the finale review call label. I removed it.

seisman · 2022-11-23T12:05:15Z

Some failures:

Traceback (most recent call last):
  File "/Users/runner/work/pygmt/pygmt/examples/gallery/lines/wiggle.py", line 22, in <module>
    fig.wiggle(
  File "/Users/runner/miniconda3/envs/pygmt/lib/python3.10/site-packages/pygmt/helpers/decorators.py", line 594, in new_module
    return module_func(*args, **kwargs)
  File "/Users/runner/miniconda3/envs/pygmt/lib/python3.10/site-packages/pygmt/helpers/decorators.py", line 734, in new_module
    return module_func(*args, **kwargs)
  File "/Users/runner/miniconda3/envs/pygmt/lib/python3.10/site-packages/pygmt/src/wiggle.py", line 105, in wiggle
    module="wiggle", args=build_arg_string(kwargs, infile=fname)
  File "/Users/runner/miniconda3/envs/pygmt/lib/python3.10/site-packages/pygmt/helpers/utils.py", line 212, in build_arg_string
    raise GMTInvalidInput(f"Unrecognized parameter '{key}'.")
pygmt.exceptions.GMTInvalidInput: Unrecognized parameter 'fill'.


/Users/runner/work/pygmt/pygmt/examples/gallery/symbols/scatter.py failed leaving traceback:
Traceback (most recent call last):
  File "/Users/runner/work/pygmt/pygmt/examples/gallery/symbols/scatter.py", line 36, in <module>
    label=f"{color}+S0.25c",
NameError: name 'color' is not defined


/Users/runner/work/pygmt/pygmt/examples/gallery/symbols/bars.py failed leaving traceback:
Traceback (most recent call last):
  File "/Users/runner/work/pygmt/pygmt/examples/gallery/symbols/bars.py", line 41, in <module>
    fig.plot(x=1, y=2, style="b0.5c", fill=color, pen=pen)
NameError: name 'color' is not defined

michaelgrund · 2022-11-23T15:48:30Z

Some failures:

Traceback (most recent call last):
  File "/Users/runner/work/pygmt/pygmt/examples/gallery/lines/wiggle.py", line 22, in <module>
    fig.wiggle(
  File "/Users/runner/miniconda3/envs/pygmt/lib/python3.10/site-packages/pygmt/helpers/decorators.py", line 594, in new_module
    return module_func(*args, **kwargs)
  File "/Users/runner/miniconda3/envs/pygmt/lib/python3.10/site-packages/pygmt/helpers/decorators.py", line 734, in new_module
    return module_func(*args, **kwargs)
  File "/Users/runner/miniconda3/envs/pygmt/lib/python3.10/site-packages/pygmt/src/wiggle.py", line 105, in wiggle
    module="wiggle", args=build_arg_string(kwargs, infile=fname)
  File "/Users/runner/miniconda3/envs/pygmt/lib/python3.10/site-packages/pygmt/helpers/utils.py", line 212, in build_arg_string
    raise GMTInvalidInput(f"Unrecognized parameter '{key}'.")
pygmt.exceptions.GMTInvalidInput: Unrecognized parameter 'fill'.


/Users/runner/work/pygmt/pygmt/examples/gallery/symbols/scatter.py failed leaving traceback:
Traceback (most recent call last):
  File "/Users/runner/work/pygmt/pygmt/examples/gallery/symbols/scatter.py", line 36, in <module>
    label=f"{color}+S0.25c",
NameError: name 'color' is not defined


/Users/runner/work/pygmt/pygmt/examples/gallery/symbols/bars.py failed leaving traceback:
Traceback (most recent call last):
  File "/Users/runner/work/pygmt/pygmt/examples/gallery/symbols/bars.py", line 41, in <module>
    fig.plot(x=1, y=2, style="b0.5c", fill=color, pen=pen)
NameError: name 'color' is not defined

To fix the warnings regarding Figure.wiggle, first #2205 needs to be merged.

seisman · 2022-11-24T09:55:13Z

Some failures:

Traceback (most recent call last):
  File "/Users/runner/work/pygmt/pygmt/examples/gallery/lines/wiggle.py", line 22, in <module>
    fig.wiggle(
  File "/Users/runner/miniconda3/envs/pygmt/lib/python3.10/site-packages/pygmt/helpers/decorators.py", line 594, in new_module
    return module_func(*args, **kwargs)
  File "/Users/runner/miniconda3/envs/pygmt/lib/python3.10/site-packages/pygmt/helpers/decorators.py", line 734, in new_module
    return module_func(*args, **kwargs)
  File "/Users/runner/miniconda3/envs/pygmt/lib/python3.10/site-packages/pygmt/src/wiggle.py", line 105, in wiggle
    module="wiggle", args=build_arg_string(kwargs, infile=fname)
  File "/Users/runner/miniconda3/envs/pygmt/lib/python3.10/site-packages/pygmt/helpers/utils.py", line 212, in build_arg_string
    raise GMTInvalidInput(f"Unrecognized parameter '{key}'.")
pygmt.exceptions.GMTInvalidInput: Unrecognized parameter 'fill'.


/Users/runner/work/pygmt/pygmt/examples/gallery/symbols/scatter.py failed leaving traceback:
Traceback (most recent call last):
  File "/Users/runner/work/pygmt/pygmt/examples/gallery/symbols/scatter.py", line 36, in <module>
    label=f"{color}+S0.25c",
NameError: name 'color' is not defined


/Users/runner/work/pygmt/pygmt/examples/gallery/symbols/bars.py failed leaving traceback:
Traceback (most recent call last):
  File "/Users/runner/work/pygmt/pygmt/examples/gallery/symbols/bars.py", line 41, in <module>
    fig.plot(x=1, y=2, style="b0.5c", fill=color, pen=pen)
NameError: name 'color' is not defined

To fix the warnings regarding Figure.wiggle, first #2205 needs to be merged.

I think you can revert the changes for Figure.wiggle and Figure.velo, and make the changes in PR #2205 and #2206 instead.

michaelgrund · 2022-11-24T10:40:09Z

/format

michaelgrund · 2022-11-24T10:48:58Z

/format

seisman

Looks good.

…MappingTools#2201)

michaelgrund added 5 commits November 22, 2022 09:00

Update parameter 'color' to 'fill' in examples

a3278a9

Addresses #1617

Update great_circles.py

fbda1c3

Update linefronts.py

6ed4586

Update vector_heads_tails.py

c5dbc51

Update basic_symbols.py

5296223

michaelgrund added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Nov 22, 2022

michaelgrund added this to the 0.8.0 milestone Nov 22, 2022

michaelgrund mentioned this pull request Nov 22, 2022

In some functions, G is aliased as "fill" but shown "color" in docstrings #1617

Closed

michaelgrund added 4 commits November 22, 2022 09:13

Update points_categorical.py

8d8bcd5

Update custom_symbols.py

8728c0f

Update datetime_inputs.py

bd7e718

Update multi_parameter_symbols.py

71f677c

seisman approved these changes Nov 22, 2022

View reviewed changes

seisman added the final review call This PR requires final review and approval from a second reviewer label Nov 22, 2022

michaelgrund marked this pull request as draft November 22, 2022 13:44

yvonnefroehlich removed the final review call This PR requires final review and approval from a second reviewer label Nov 22, 2022

michaelgrund added 10 commits November 23, 2022 09:33

Merge branch 'main' into gallery-color-to-fill

d3fe5df

Update points.py

d3aca4d

Update points_transparency.py

6a704a6

Update scatter.py

b4b8389

Update text_symbols.py

89f5c41

Update track_sampling.py

2d7c511

Update double_y_axes.py

c47fd54

Update blockm.py

71469f6

Update legend.py

a97be18

Update plot.py

eef46b8

michaelgrund added 7 commits November 23, 2022 10:23

Update vectors.py

567de63

Update vectors.py

e8b2f8e

Update cartesian_logarithmic.py

0fc5beb

Update cartesian_power.py

f6f2b9b

Update scatter3d.py

799792b

Update wiggle.py

04351ad

Update bars.py

521fe3d

michaelgrund marked this pull request as ready for review November 23, 2022 09:44

michaelgrund added the needs review This PR has higher priority and needs review. label Nov 23, 2022

michaelgrund added 2 commits November 23, 2022 14:47

Update bars.py

feab550

Update scatter.py

2a6b3a1

Update wiggle.py

b3cfc17

michaelgrund and others added 3 commits November 24, 2022 11:40

Merge branch 'main' into gallery-color-to-fill

f5e8140

[format-command] fixes

6f2dc12

Update cartesian_power.py

2c3b92b

[format-command] fixes

12c2cf8

seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Nov 24, 2022

seisman approved these changes Nov 24, 2022

View reviewed changes

seisman removed the final review call This PR requires final review and approval from a second reviewer label Nov 25, 2022

seisman merged commit 89916b6 into main Nov 25, 2022

seisman deleted the gallery-color-to-fill branch November 25, 2022 07:39

yvonnefroehlich mentioned this pull request Dec 8, 2022

Update parameter 'uncertaintycolor' to 'uncertaintyfill' in example 'velo_arrow_ellipse.py' #2237

Merged

6 tasks

sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022

Update parameter 'color' to 'fill' in examples and tutorials (Generic…

2f15685

…MappingTools#2201)

yvonnefroehlich mentioned this pull request Jul 19, 2024

Gallery example "Color points by categories": Update "color" to "fill" in introduction text #3340

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update parameter 'color' to 'fill' in examples and tutorials #2201

Update parameter 'color' to 'fill' in examples and tutorials #2201

Uh oh!

michaelgrund commented Nov 22, 2022

Uh oh!

yvonnefroehlich commented Nov 22, 2022

Uh oh!

michaelgrund commented Nov 22, 2022

Uh oh!

yvonnefroehlich commented Nov 22, 2022 •

edited

Loading

Uh oh!

seisman commented Nov 23, 2022

Uh oh!

michaelgrund commented Nov 23, 2022

Uh oh!

seisman commented Nov 24, 2022

Uh oh!

michaelgrund commented Nov 24, 2022

Uh oh!

michaelgrund commented Nov 24, 2022

Uh oh!

seisman left a comment

Uh oh!

Uh oh!

Update parameter 'color' to 'fill' in examples and tutorials #2201

Update parameter 'color' to 'fill' in examples and tutorials #2201

Uh oh!

Conversation

michaelgrund commented Nov 22, 2022

Uh oh!

yvonnefroehlich commented Nov 22, 2022

Uh oh!

michaelgrund commented Nov 22, 2022

Uh oh!

yvonnefroehlich commented Nov 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

seisman commented Nov 23, 2022

Uh oh!

michaelgrund commented Nov 23, 2022

Uh oh!

seisman commented Nov 24, 2022

Uh oh!

michaelgrund commented Nov 24, 2022

Uh oh!

michaelgrund commented Nov 24, 2022

Uh oh!

seisman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

yvonnefroehlich commented Nov 22, 2022 •

edited

Loading