Skip to content

Link from projection parameter to gallery - #1044

Merged
seisman merged 3 commits into
masterfrom
common-projections
Mar 13, 2021
Merged

Link from projection parameter to gallery#1044
seisman merged 3 commits into
masterfrom
common-projections

Conversation

@maxrjones

Copy link
Copy Markdown
Member

Description of proposed changes

This PR links to the projections gallery from the projection parameter in the API docs. I do not think the projections common text (see basemap for an example) provides enough information to be usable on its own, so this provides a link to more information.

Fixes #

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

@maxrjones maxrjones added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Mar 12, 2021
@seisman

seisman commented Mar 12, 2021

Copy link
Copy Markdown
Member

One of the related doctests fails:

_______________ [doctest] pygmt.helpers.decorators.fmt_docstring _______________
179     ...
180     ...     Parameters
181     ...     ----------
182     ...     {R}
183     ...     {J}
184     ...
185     ...     {aliases}
186     ...     '''
187     ...     pass
188     >>> print(gmtinfo.__doc__)
Differences (unified diff with -expected +actual):
    @@ -11,5 +11,5 @@
         *Required if this is the first plot command*.
         *projcode*\[*projparams*/]\ *width*.
    -    Select map projection.
    +    Select map :doc:`projection </projections/index>`.
     <BLANKLINE>

You also need to update this line

Select map projection.

@seisman seisman added this to the 0.3.1 milestone Mar 12, 2021
@seisman seisman changed the title Link from projections parameter to gallery Link from projection parameter to gallery Mar 13, 2021
@seisman
seisman merged commit 8899369 into master Mar 13, 2021
@seisman
seisman deleted the common-projections branch March 13, 2021 01:42
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.

2 participants