Skip to content
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.

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

Figure.text: Improve the documentation to clarify the order of columns in the input files #2832

Merged
merged 5 commits into from
Dec 5, 2023

Conversation

seisman
Copy link
Member

@seisman seisman commented Nov 26, 2023

@seisman seisman added the documentation Improvements or additions to documentation label Nov 26, 2023
@seisman seisman added this to the 0.11.0 milestone Nov 26, 2023
@seisman seisman added skip-changelog Skip adding Pull Request to changelog needs review This PR has higher priority and needs review. labels Nov 26, 2023
@seisman seisman changed the title Figure.text: Improve the documentation to clariry the order of columns in the input files Figure.text: Improve the documentation to clarify the order of columns in the input files Nov 26, 2023
pygmt/src/text.py Outdated Show resolved Hide resolved
pygmt/src/text.py Outdated Show resolved Hide resolved
pygmt/src/text.py Outdated Show resolved Hide resolved
pygmt/src/text.py Outdated Show resolved Hide resolved
Co-authored-by: Yvonne Fröhlich <[email protected]>
* *y*: Y coordinate or latitude
* *angle*: Angle in degrees counter-clockwise from horizontal
* *font*: Text size, font, and color
* *justify*: Two-character justification code
Copy link
Member

@yvonnefroehlich yvonnefroehlich Nov 28, 2023

Choose a reason for hiding this comment

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

Here we write currently two-character justification code. But we write

  • below for the justify parameter two-letter combination
  • in the colorbar example 2-character combination
  • in the text tutorial two-letter (order independent) code
  • etc.

I think it would be nice to formulate this consistently. This is a bit related to issue #2834. I will try to find time to look at this in more detail; currently busy with other things.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, we can simplify these descriptions if issue #2834 is addressed.

Copy link
Member

Choose a reason for hiding this comment

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

Then maybe we leave these formulations as they are for now, and make it consistent via addressing #2834 🙂.

@seisman seisman requested a review from a team December 4, 2023 16:34
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Dec 5, 2023
@seisman seisman merged commit 5f6460b into main Dec 5, 2023
16 checks passed
@seisman seisman deleted the text/docs branch December 5, 2023 03:40
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Dec 5, 2023
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 skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Figure.text: Parsing of additional arguments when plotting text from file
2 participants