gmt icon indicating copy to clipboard operation
gmt copied to clipboard

Adjust colorbar sidebar parameter description

Open michaelgrund opened this issue 1 month ago • 2 comments

Description of proposed changes

In the definition it's length, so replace width by length in the description.

Reminders

  • [ ] Make sure that your code follows our style. Use the other functions/files as a basis.
  • [ ] Add tests for new features or tests that would have caught the bug that you're fixing.
  • [ ] Describe changes to function behavior and arguments in a comment below the function declaration.
  • [ ] If adding new functionality, add a detailed description to the documentation and/or an example.

michaelgrund avatar Dec 16 '25 08:12 michaelgrund

I don't think the description is wrong. It really means the height and states that the default height is equal to bar's width.

For me that's unclear. In the paramter list it's length (why not width then): image

and in the description: image

michaelgrund avatar Dec 17 '25 07:12 michaelgrund

Yep, the length in the option synopsis may be a bit misleading, but just a little since it's neither width nor height so it should not be confusing either.

joa-quim avatar Dec 17 '25 13:12 joa-quim

ok, if you might this is clear then we can close this.

michaelgrund avatar Dec 19 '25 08:12 michaelgrund