Skip to content

Add docstring example to Figure.logo #4458

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

Open
Silver19368 wants to merge 4 commits into
base: main
Choose a base branch
from
+12 −0
Open

Add docstring example to Figure.logo #4458

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e8c02c
Add example to Figure.logo docstring
Silver19368 Mar 20, 2026
f6055a7
Merge branch 'main' into logo-chido
Silver19368 Mar 20, 2026
a1746a7
Update logo example with basemap and explicit offsets to fix CI
Silver19368 Mar 20, 2026
6eab561
Merge branch 'logo-chido' of https://github.com/Silver19368/pygmt int…
Silver19368 Mar 20, 2026
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
12 changes: 12 additions & 0 deletions pygmt/src/logo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,18 @@ def logo( # noqa: PLR0913
$panel
$perspective
$transparency

Examples
--------
>>> import pygmt
>>> from pygmt.params import Position
>>> fig = pygmt.Figure()
>>> # Create a basemap to give the plot a coordinate system
Copy link
Member

@yvonnefroehlich yvonnefroehlich Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm. I am wondering whether we should focus on the specific function or method and only add comments for this.

Suggested change
>>> # Create a basemap to give the plot a coordinate system

>>> fig.basemap(region=[0, 10, 0, 10], projection="X10c", frame=True)
>>> # Add the GMT logo in the Top Right (TR) corner of the plot,
>>> # scaled to be 2 cm wide and offset by 0.5 cm in x and y.
Copy link
Member

@yvonnefroehlich yvonnefroehlich Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
>>> # scaled to be 2 cm wide and offset by 0.5 cm in x and y.
>>> # scaled to be 2 cm wide and offset by 0.5 cm in x and y directions.

>>> fig.logo(position=Position("TR", offset="0.5c/0.5c"), width="2c")
>>> fig.show()
"""
self._activate_figure()

Expand Down
Loading