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

Add an "add a title" to starter tutorial #1688

Merged
merged 7 commits into from
Jan 3, 2022
Merged

Add an "add a title" to starter tutorial #1688

merged 7 commits into from
Jan 3, 2022

Conversation

willschlitzer
Copy link
Contributor

I originally intended to add a second page to the tutorial that covered adding a title, but changed my mind and think the title section would be more appropriate in first_figure.py rather than adding a separate page, which this PR does.

Additionally, to reduce confusion over switching between frame=True and frame=["a", "+tMaine"], this changes the frame example to use frame="a".

Addresses #770

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

@willschlitzer willschlitzer added the documentation Improvements or additions to documentation label Dec 30, 2021
@willschlitzer willschlitzer added this to the 0.6.0 milestone Dec 30, 2021
@willschlitzer willschlitzer self-assigned this Dec 30, 2021
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Dec 30, 2021
examples/get-started/first_figure.py Outdated Show resolved Hide resolved
examples/get-started/first_figure.py Outdated Show resolved Hide resolved
@@ -121,8 +121,7 @@
# annotate the latitude and longitude of the region.
#
# The ``frame`` parameter is used to add a frame to the figure. For now, it
# will be set to ``True`` to use default settings, but later tutorials will
# show how ``frame`` can be used to customize the axes, gridlines, and titles.
# will be set to ``"a"`` to **a**nnotate the axes automatically.
Copy link
Member

Choose a reason for hiding this comment

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

Oops, forgot that this is RST and not markdown. How do you set bold text again?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed in 606ee98.

@willschlitzer
Copy link
Contributor Author

@GenericMappingTools/pygmt-admin Can I get someone to merge this? Thanks!

@seisman seisman merged commit dfb231a into main Jan 3, 2022
@seisman seisman deleted the tutorial/title branch January 3, 2022 12:55
@willschlitzer willschlitzer removed the final review call This PR requires final review and approval from a second reviewer label Jan 4, 2022
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants