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

Figure.plot3d: Deprecate parameter "columns" to "incols" (remove in v0.6.0) #1040

Merged
merged 13 commits into from
Jun 17, 2021

Conversation

willschlitzer
Copy link
Contributor

@willschlitzer willschlitzer commented Mar 12, 2021

As discussed by @weiji14, this is to add the parameter description for incols in plot3d.py.

Fixes #764

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 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

@willschlitzer willschlitzer added this to the 0.3.1 milestone Mar 12, 2021
pygmt/src/plot3d.py Outdated Show resolved Hide resolved
pygmt/src/plot3d.py Outdated Show resolved Hide resolved
pygmt/src/plot3d.py Outdated Show resolved Hide resolved
@seisman
Copy link
Member

seisman commented Mar 12, 2021

@willschlitzer please see my comments at #764 (comment).

@willschlitzer willschlitzer modified the milestones: 0.3.1, 0.4.0 Mar 12, 2021
@willschlitzer willschlitzer marked this pull request as draft March 12, 2021 21:22
@willschlitzer
Copy link
Contributor Author

Converting to draft to hold off until v0.4.0

@seisman
Copy link
Member

seisman commented Jun 3, 2021

Ping @willschlitzer to work on this issue if available.

@willschlitzer
Copy link
Contributor Author

willschlitzer commented Jun 6, 2021

Ping @willschlitzer to work on this issue if available.

I'm planning on working on this when I get back home on June 14.

@willschlitzer willschlitzer marked this pull request as ready for review June 15, 2021 05:38
@willschlitzer
Copy link
Contributor Author

I have updated this per the comments in #764 and changed columns to incols

pygmt/src/plot3d.py Outdated Show resolved Hide resolved
Co-authored-by: Michael Grund <[email protected]>
@maxrjones maxrjones mentioned this pull request Jun 15, 2021
27 tasks
pygmt/src/plot3d.py Outdated Show resolved Hide resolved
@weiji14 weiji14 changed the title Add columns parameter to plot3d.py Add incols parameter to plot3d.py Jun 15, 2021
pygmt/src/plot3d.py Outdated Show resolved Hide resolved
pygmt/src/plot3d.py Outdated Show resolved Hide resolved
@seisman seisman changed the title Add incols parameter to plot3d.py Figure.plot3d: Deprecate parameter "columns" to "incols" (remove in v0.6.0) Jun 17, 2021
@seisman seisman added the deprecation Deprecating a feature label Jun 17, 2021
@seisman seisman merged commit e750d0d into master Jun 17, 2021
@seisman seisman deleted the columns-plot3d branch June 17, 2021 15:53
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…0.6.0) (GenericMappingTools#1040)

* Add "incols" parameter in plot3d.py
* change data accepted types to include table-like
* add @deprecate_parameter for columns parameter
* add test for deprecated "columns" parameter in plot3d

Co-authored-by: Meghan Jones <[email protected]>
Co-authored-by: Michael Grund <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation Deprecating a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Description for the "columns" arguments is missing
5 participants