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/Gallery example "Cross-section along a transect": General improvements #3623

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

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Nov 17, 2024

Description of proposed changes

This PR contains general improvements of the Gallery example "Cross-section along a transect":

  • Use lists as input for the center and endpoint parameters
  • Make argument passed to xshift flexible
  • Re-wrapp to 88 chars
  • Improve comments

Preview: https://pygmt-dev--3623.org.readthedocs.build/en/3623/gallery/images/cross_section.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 skip-changelog Skip adding Pull Request to changelog labels Nov 17, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.14.0 milestone Nov 17, 2024
@yvonnefroehlich yvonnefroehlich self-assigned this Nov 17, 2024
@yvonnefroehlich yvonnefroehlich changed the title DOC/Gallery example "Cross-section along a transect": Use list for "center" and "endpoint" parameters DOC/Gallery example "Cross-section along a transect": Use lists for "center" and "endpoint" parameters Nov 17, 2024
@yvonnefroehlich yvonnefroehlich changed the title DOC/Gallery example "Cross-section along a transect": Use lists for "center" and "endpoint" parameters DOC/Gallery example "Cross-section along a transect": Minor code improvements Nov 17, 2024
@seisman
Copy link
Member

seisman commented Nov 17, 2024

The changes look good to me. Could you please also rewrap the lines to <88 characters?

@yvonnefroehlich
Copy link
Member Author

yvonnefroehlich commented Nov 17, 2024

The changes look good to me. Could you please also rewrap the lines to <88 characters?

Done in afbbdab.
Edit: and df1a8de.

examples/gallery/images/cross_section.py Outdated Show resolved Hide resolved
examples/gallery/images/cross_section.py Outdated Show resolved Hide resolved
examples/gallery/images/cross_section.py Outdated Show resolved Hide resolved
examples/gallery/images/cross_section.py Outdated Show resolved Hide resolved
@yvonnefroehlich yvonnefroehlich changed the title DOC/Gallery example "Cross-section along a transect": Minor code improvements DOC/Gallery example "Cross-section along a transect": General improvements Nov 17, 2024
examples/gallery/images/cross_section.py Outdated Show resolved Hide resolved
examples/gallery/images/cross_section.py Outdated Show resolved Hide resolved
examples/gallery/images/cross_section.py Outdated Show resolved Hide resolved
yvonnefroehlich and others added 3 commits November 18, 2024 07:26
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@yvonnefroehlich yvonnefroehlich added the maintenance Boring but important stuff for the core devs label Nov 18, 2024
yvonnefroehlich and others added 2 commits November 18, 2024 18:01
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Nov 19, 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 final review call This PR requires final review and approval from a second reviewer maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants