WIP: Figure.colorbar: Add alias "no_font_scaling" for "-H"

[yvonnefroehlich]

Description of proposed changes

This PR aims to add an alias for the newly added -H flag of colorbar of GMT 6.7.0. Currently it's no_font_scaling. Feel free to make suggestion for a suitable alias.

TODO

• Find alias name: no_font_scaling default False
• Add alias
• Update note

Related: #4243

Preview: https://pygmt-dev--4783.org.readthedocs.build/en/4783/api/generated/pygmt.Figure.colorbar.html

Example

import pygmt

size = 5
args_bmap = {
    "region": [-size, size] * 2,
    "projection": f"X{size * 2}c",
    "frame": True,
}
args_cb = {
    "cmap": "batlow",
    "position": "jMC+h+w1c",
    "frame": "x+ltitle for a very short cb",
}


fig = pygmt.Figure()

fig.basemap(**args_bmap)
fig.colorbar(**args_cb)

fig.shift_origin(xshift=f"+{size*2+1}c")

fig.basemap(**args_bmap)
fig.colorbar(no_font_scaling=True, **args_cb)   # H = True

fig.show()

Guidelines

• General Guidelines for Pull Request
• Guidelines for Contributing Documentation
• Guidelines for Contributing Code

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

[seisman]

maybe font_scaling with default
to True

[yvonnefroehlich]

maybe font_scaling with default to True

Hmmm. Seems we will have fun with double negatives here 😅. My understanding and thoughts so far are:
In GMT, not using -H means the auto-scaling applies. Setting -H turns off the auto-scaling. Setting a flag in GMT without any argument translates in PyGMT to True. So H=True leads to "no auto-scaling is applied". Based on this, the alias for H should contain the "no", with the default False as then no no auto-scaling (i.e., auto-scaling) is applied 😆.

[seisman]

we can use not font_scaling internally

[seisman]

maybe font_scaling with default to True

Hmmm. Seems we will have fun with double negatives here 😅. My understanding and thoughts so far are: In GMT, not using -H means the auto-scaling applies. Setting -H turns off the auto-scaling. Setting a flag in GMT without any argument translates in PyGMT to True. So H=True leads to "no auto-scaling is applied". Based on this, the alias for H should contain the "no", with the default False as then no no auto-scaling (i.e., auto-scaling) is applied 😆.

After thinking it twice, I agree that font_scaling=True as the default is confusing. So let's use no_font_scaling.

[seisman]

The -H option only exists in GMT>=6.7.0, so need to check the current GMT version, and raise an exception if GMT 6.5/6.6 is used and no_font_scaling=True.

[seisman]

maybe font_scaling with default to True

Hmmm. Seems we will have fun with double negatives here 😅. My understanding and thoughts so far are: In GMT, not using -H means the auto-scaling applies. Setting -H turns off the auto-scaling. Setting a flag in GMT without any argument translates in PyGMT to True. So H=True leads to "no auto-scaling is applied". Based on this, the alias for H should contain the "no", with the default False as then no no auto-scaling (i.e., auto-scaling) is applied 😆.

After thinking it twice, I agree that font_scaling=True as the default is confusing. So let's use no_font_scaling.

Actually, I wonder if we should have the default to be no font scaling. From what I hear, the font scaling feature has confused users for a few years, and people may prefer no font scaling as the default. So, what about having

• font_scaling=False: The default. Translated to -H.
• font_scaling=True: If users want such a feature. No -H.

I know it's inconsistent with the default GMT behavior, but I wonder if no font scaling is more frequently used.

[seisman]

maybe font_scaling with default to True

Hmmm. Seems we will have fun with double negatives here 😅. My understanding and thoughts so far are: In GMT, not using -H means the auto-scaling applies. Setting -H turns off the auto-scaling. Setting a flag in GMT without any argument translates in PyGMT to True. So H=True leads to "no auto-scaling is applied". Based on this, the alias for H should contain the "no", with the default False as then no no auto-scaling (i.e., auto-scaling) is applied 😆.

After thinking it twice, I agree that font_scaling=True as the default is confusing. So let's use no_font_scaling.

Actually, I wonder if we should have the default to be no font scaling. From what I hear, the font scaling feature has confused users for a few years, and people may prefer no font scaling as the default. So, what about having

• font_scaling=False: The default. Translated to -H.
• font_scaling=True: If users want such a feature. No -H.

I know it's inconsistent with the default GMT behavior, but I wonder if no font scaling is more frequently used.

Likely a bad idea, because -H requires GMT>=6.7.0, thus people with different GMT versions will see different default behavior. Let's use no_font_scaling=False as default.

[seisman]

I feel this note can be moved to the docstrings for no_font_scaling.