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

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

Open
wants to merge 16 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
@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
@yvonnefroehlich yvonnefroehlich changed the title POC: WIP: DOC: Add basic tutorial "Plotting single-parameter symbols" WIP: DOC: Add basic tutorial "Plotting single-parameter symbols" Nov 10, 2024
@yvonnefroehlich yvonnefroehlich changed the title WIP: DOC: Add basic tutorial "Plotting single-parameter symbols" DOC: Add basic tutorial "Plotting single-parameter symbols" Nov 13, 2024
@yvonnefroehlich yvonnefroehlich added the needs review This PR has higher priority and needs review. label Nov 13, 2024
@seisman
Copy link
Member

seisman commented Nov 14, 2024

Just want to let you know that the example can be simplified after #3602 is finished.

@yvonnefroehlich
Copy link
Member Author

Just want to let you know that the example can be simplified after #3602 is finished.

In principle, I am fine with updating this tutorial later. Do you plan to get this new high-level Figure.scatter method into v0.14.0? As the symbol parameter will be new in v0.14.0 and there will be probably some confusion with the style and size parameters, I think we should have an example / tutorial explaining the usage and differences by these parameters.

@seisman
Copy link
Member

seisman commented Nov 25, 2024

Do you plan to get this new high-level Figure.scatter method into v0.14.0?

Yes.

As the symbol parameter will be new in v0.14.0 and there will be probably some confusion with the style and size parameters, I think we should have an example / tutorial explaining the usage and differences by these parameters.

The ultimate goal is let Figure.plot focus on plotting lines and polygons, and have separate plotting methods (e.g., Figure.scatter, Figure.rectangle, Figure.frontline and more) for other single-parameter and multi-parameter symbols/lines.

@yvonnefroehlich yvonnefroehlich marked this pull request as draft November 28, 2024 11:54
@yvonnefroehlich yvonnefroehlich marked this pull request as draft November 28, 2024 11:54
@yvonnefroehlich
Copy link
Member Author

Maye we leave this PR as is for the moment and short before we release of v0.14.0 we can come back and apply updates based on the state of the planed high-level methods. Thus, I set this PR to draft.

@seisman seisman removed the needs review This PR has higher priority and needs review. label Nov 28, 2024
@seisman seisman removed this from the 0.14.0 milestone Nov 28, 2024
@yvonnefroehlich yvonnefroehlich mentioned this pull request Dec 16, 2024
49 tasks
@seisman seisman added this to the 0.14.0 milestone Dec 19, 2024
@yvonnefroehlich yvonnefroehlich marked this pull request as ready for review December 24, 2024 13:19
@yvonnefroehlich yvonnefroehlich added the needs review This PR has higher priority and needs review. label Dec 24, 2024
@yvonnefroehlich
Copy link
Member Author

Maye we leave this PR as is for the moment and short before we release of v0.14.0 we can come back and apply updates based on the state of the planed high-level methods. Thus, I set this PR to draft.

As we will not have Figure.scatter in v0.14.0 (please see #3602 (comment)), should we use this tutorial to explain the newly added symbol paramter or move this PR also to v0.15.0?

@seisman
Copy link
Member

seisman commented Dec 25, 2024

I still prefer to have this PR after Figure.scatter is implemented. To address your concern in #3595, we could update the docstring in plot/plot3d.

@yvonnefroehlich
Copy link
Member Author

I still prefer to have this PR after Figure.scatter is implemented.

This is fine for me. Have changed the milestone to v0.15.0.

@yvonnefroehlich yvonnefroehlich modified the milestones: 0.14.0, 0.15.0 Dec 25, 2024
@seisman seisman removed the needs review This PR has higher priority and needs review. label Dec 26, 2024
@seisman seisman removed this from the 0.15.0 milestone Dec 31, 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"
3 participants