Skip to content

Conversation

@michaelgrund
Copy link
Member

@michaelgrund michaelgrund commented Dec 16, 2025

Description of proposed changes

Although there will be some changes (see #4168), this PR adds the description for missing settings of the position parameter.

To become more Pythonic I propose that some of the parameters (like the sidebar triangles) deserve an standalone definition in the future, sth. like:

colorbar(..., sidebar = "foreground")
colorbar(..., sidebar = "background")
colorbar(..., sidebar = "both")

Preview:

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

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

@michaelgrund michaelgrund added the documentation Improvements or additions to documentation label Dec 16, 2025
@michaelgrund michaelgrund changed the title DOC: Add description for colorbar sidebars to docs DOC: Add missing descriptions for colorbar position parameter Dec 16, 2025
@seisman
Copy link
Member

seisman commented Dec 16, 2025

I prefer not to accept this PR and instead focus on improving the documentation in PR #4048.

@michaelgrund
Copy link
Member Author

Ah, damn did not find that PR when I searched for content. Will give feedback on PR #4048

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants