Skip to content

List deprecated load_* functions in a separate table - #2228

Merged
seisman merged 2 commits into
mainfrom
table-for-load-functions
Dec 7, 2022
Merged

List deprecated load_* functions in a separate table#2228
seisman merged 2 commits into
mainfrom
table-for-load-functions

Conversation

@seisman

Copy link
Copy Markdown
Member

Description of proposed changes

Address comment #2125 (comment)

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.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@seismanseisman added the documentation Improvements or additions to documentation label Dec 6, 2022
@seismanseisman added this to the 0.8.0 milestone Dec 6, 2022
@seismanseisman added the skip-changelog Skip adding Pull Request to changelog label Dec 6, 2022

@willschlitzerwillschlitzer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good.

Only issue is that there is a horizontal slider to read all of the description of the deprecated dataset functions. I don't think it's that big of a deal, and will be gone anyway in a few releases.

@seismanseisman added the final review call This PR requires final review and approval from a second reviewer label Dec 6, 2022

@weiji14weiji14 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Two minor suggestions, otherwise ok!

Comment threaddoc/api/index.rst Outdated
Comment threaddoc/api/index.rst Outdated
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@seismanseisman removed the final review call This PR requires final review and approval from a second reviewer label Dec 7, 2022
@seisman
seisman merged commit f2924ea into mainDec 7, 2022
@seisman
seisman deleted the table-for-load-functions branch December 7, 2022 00:01
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…ools#2228)
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@seisman@weiji14@willschlitzer