Skip to content

Figure.plot: Rename "fill_between" to "between_fill" (alias for -M)#4527

Draft
yvonnefroehlich wants to merge 2 commits intomainfrom
rename-to-between_fill
Draft

Figure.plot: Rename "fill_between" to "between_fill" (alias for -M)#4527
yvonnefroehlich wants to merge 2 commits intomainfrom
rename-to-between_fill

Conversation

@yvonnefroehlich
Copy link
Copy Markdown
Member

Description of proposed changes

Rename fill_between to beween_fill for _M to be consistent with the other *_fill parameters.
Extends: #3169

Guidelines

Slash Commands

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

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added this to the 0.19.0 milestone Apr 10, 2026
@yvonnefroehlich yvonnefroehlich self-assigned this Apr 10, 2026
@yvonnefroehlich yvonnefroehlich added the enhancement Improving an existing feature label Apr 10, 2026
@yvonnefroehlich yvonnefroehlich marked this pull request as draft April 14, 2026 08:46
@yvonnefroehlich
Copy link
Copy Markdown
Member Author

In PR #3169, fill_between was added as an alias for -M of Figure.plot. This is consistent with the method used by matplotlib (https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.fill_between.html). However, to be consistent with other parameter names, it should be between_fill, e.g., positive_fill and negative_fill of Figure.wiggle. See also #3169 (comment). @GenericMappingTools/pygmt-maintainers What do people prefer:

  • 🎉 Keep fill_between
  • 🚀 Change to between_fill

@seisman
Copy link
Copy Markdown
Member

seisman commented Apr 14, 2026

One thing to note is that in parameters such as positive_fill and negative_fill, fill is a noun, whereas in fill_between, it is more like a verb.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Improving an existing feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants