Skip to content

Copy interval docs from grdcontour.py to the levels docs in contour.py - #1043

Merged
seisman merged 5 commits into
masterfrom
levels-contour-update
Mar 13, 2021
Merged

Copy interval docs from grdcontour.py to the levels docs in contour.py#1043
seisman merged 5 commits into
masterfrom
levels-contour-update

Conversation

@willschlitzer

Copy link
Copy Markdown
Contributor

As pointed out by @meghanrjones in #1042, the parameter levels in contour.py is the same as interval in grdcontour.py. The interval documentation was much more complete than the levels documentation; this pull request copies the documentation from interval to levels.

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 the documentation Improvements or additions to documentation label Mar 12, 2021
@willschlitzer willschlitzer added this to the 0.3.1 milestone Mar 12, 2021
Comment thread pygmt/src/contour.py Outdated
levels : str or int
Specify the contour lines to generate.

- The filename of a `CPT` file where the color boundaries will

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.

Suggested change
- The filename of a `CPT` file where the color boundaries will
- The filename of a CPT file where the color boundaries will

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.

@willschlitzer Could you also make the same fix in grdcontour.py?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done in 50fbf4e

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@seisman seisman added the skip-changelog Skip adding Pull Request to changelog label Mar 13, 2021
@seisman
seisman merged commit aaee599 into master Mar 13, 2021
@seisman
seisman deleted the levels-contour-update branch March 13, 2021 15:49
@maxrjones

Copy link
Copy Markdown
Member

Is the no approval for this and #1044 a GitHub bug or a force merge?

@seisman

seisman commented Mar 13, 2021

Copy link
Copy Markdown
Member

It's a simple fix so I just pushed the "force merge" button (after reviewing the changes 😃)

@maxrjones

Copy link
Copy Markdown
Member

It's a simple fix so I just pushed the "force merge" button (after reviewing the changes 😃)

OK, sounds good. I just wanted to make sure we weren't have any GitHub problems after the issues yesterday.

sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
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 skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants