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

Update README for the "Intro to PyGMT" #2678

Merged
merged 4 commits into from
Sep 12, 2023
Merged

Update README for the "Intro to PyGMT" #2678

merged 4 commits into from
Sep 12, 2023

Conversation

yvonnefroehlich
Copy link
Member

Description of proposed changes

This PR aims to expand and update the README for the "Intro to PyGMT".
I would move the note to use a Jupyter notebook from the first tutorial to the README of the intro. Actually, I am wondering whether we still need this note after PR #2662. What do others think? I'm happy to receive feedback 🙂.

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 commands are:

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

@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Sep 9, 2023
@yvonnefroehlich yvonnefroehlich added this to the 0.11.0 milestone Sep 9, 2023
@yvonnefroehlich yvonnefroehlich self-assigned this Sep 9, 2023
@seisman
Copy link
Member

seisman commented Sep 11, 2023

The tutorial's recommended method is to use a notebook, and the code will be for a notebook environment.

Before PR #529, Figure.show() only works in Jupyter Notebooks. In Python scripts, users must use Figure.show(method="external") instead. That's why we have a similar note in PyGMT v0.3.0 documentation (see https://www.pygmt.org/v0.3.0/tutorials/first-figure.html).

After PR #529, this note no longer makes sense. Users can run the examples in any environments they like (Python console, Python script, Jupyter notebooks or any others).

So I think we should remove this sentence.

@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Sep 11, 2023
@yvonnefroehlich yvonnefroehlich changed the title Expand and update README for the "Intro to PyGMT" Update README for the "Intro to PyGMT" Sep 11, 2023
@seisman seisman merged commit 47f721f into main Sep 12, 2023
7 checks passed
@seisman seisman deleted the update-intro-readme branch September 12, 2023 00:12
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Sep 12, 2023
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