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

POC: WIP: DOC: Add basic tutorial "Plotting single-parameter symbols" #3598

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Nov 7, 2024

Description of proposed changes

Add a basic tutorial for plotting symbols, explaining the style, size, and symbol parameters.

TODO: Multi parameter symbols ?

Related basic tutorials:

Fixes #3595

Preview: https://pygmt-dev--3598.org.readthedocs.build/en/3598/tutorials/basics/symbols.html

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

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

@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation enhancement Improving an existing feature labels Nov 7, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.14.0 milestone Nov 7, 2024
@yvonnefroehlich yvonnefroehlich self-assigned this Nov 7, 2024
Comment on lines 19 to 20
# points with the same symbol and size. Via the ``fill`` parameter the symbols can be
# filled with a color or pattern, and ``pen`` can add an outline (pass an argument in
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# points with the same symbol and size. Via the ``fill`` parameter the symbols can be
# filled with a color or pattern, and ``pen`` can add an outline (pass an argument in
# points with the same symbol and size. The symbols can be
# filled with a color or pattern via the ``fill`` parameter, and
# ``pen`` can add an outline (pass an argument in

Copy link
Member Author

Choose a reason for hiding this comment

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

@michaelgrund thanks for already looking at this PR. However, to be more precise regarding single- and multi-parameter symbols I made larger changes to documentation and moved this general part on the fill and pen parameter to the introduction at the top.

@yvonnefroehlich yvonnefroehlich changed the title POC: WIP: DOC: Add basic tutorial "Plotting symbols" POC: WIP: DOC: Add basic tutorial "Plotting single-parameter symbols" Nov 8, 2024
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 enhancement Improving an existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend / Add gallery example to explain "symbol" parameter of "Figure.plot"
2 participants