Skip to content

clib.Session.create_data: Improve docstrings and fix the comments for the dim parameter - #3532

Merged
seisman merged 9 commits into
mainfrom
typing/create_data
Oct 25, 2024
Merged

clib.Session.create_data: Improve docstrings and fix the comments for the dim parameter#3532
seisman merged 9 commits into
mainfrom
typing/create_data

Conversation

@seisman

@seismanseisman commented Oct 18, 2024•
edited
Loading

Copy link
Copy Markdown
Member

This PR focuses on improving the docstrings, especially for the different meanings of the dim parameter for different GMT data containers.

The failures in "Static Type Checks" may need to wait for changes in #3530.

Preview: https://pygmt-dev--3532.org.readthedocs.build/en/3532/api/generated/pygmt.clib.Session.create_data.html

@seismanseisman added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog needs review This PR has higher priority and needs review. labels Oct 18, 2024
@seismanseisman added this to the 0.14.0 milestone Oct 18, 2024
michaelgrund
michaelgrund reviewed Oct 21, 2024
View reviewed changes
Comment threadpygmt/clib/session.py Outdated
Comment threadpygmt/clib/session.py Outdated
Comment threadpygmt/clib/session.py Outdated
Comment threadpygmt/clib/session.py Outdated
Comment threadpygmt/clib/session.py Outdated
Comment threadpygmt/clib/session.py Outdated
Comment threadpygmt/clib/session.py Outdated
Comment threadpygmt/clib/session.py Outdated
@seisman@michaelgrund
Fix several typos
344410d
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
yvonnefroehlich
yvonnefroehlich reviewed Oct 21, 2024
View reviewed changes
Comment threadpygmt/clib/session.py Outdated
Comment threadpygmt/clib/session.py Outdated
seismanand others added 3 commits October 21, 2024 15:41
@seisman@yvonnefroehlich
Fix more typos
11d6f4f
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
@seisman
Merge branch 'main' into typing/create_data
911ee60
@seisman
Merge branch 'main' into typing/create_data
c2c6685
@seismanseisman 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 Oct 23, 2024
@seisman
seisman merged commit 68bb695 into mainOct 25, 2024
@seisman
seisman deleted the typing/create_data branch October 25, 2024 03:15
@seismanseisman removed the final review call This PR requires final review and approval from a second reviewer label Oct 30, 2024
@weiji14weiji14 mentioned this pull request May 3, 2025
Draft
10 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@michaelgrundmichaelgrundmichaelgrund left review comments
@yvonnefroehlichyvonnefroehlichyvonnefroehlich left review comments

Assignees

No one assigned

Labels

documentationImprovements or additions to documentationskip-changelogSkip adding Pull Request to changelog

Projects

None yet

Milestone

0.14.0

Development

Successfully merging this pull request may close these issues.

3 participants

@seisman@michaelgrund@yvonnefroehlich