Update COMMON_OPTIONS arguments to GMT standard by willschlitzer · Pull Request #783 · GenericMappingTools/pygmt

willschlitzer · 2021-01-02T11:53:43Z

Update the argument doc strings in the COMMON_OPTIONS dictionary in decorators.py to the standard set in #631.

willschlitzer · 2021-01-21T10:26:07Z

I can't figure out why this is failing so many tests, as it is changing the content of strings and no functions. It appears to be rendering correctly when it is built in Sphinx.

seisman · 2021-01-21T19:10:02Z

One doctest in pygmt.helpers.decorators.fmt_docstring fails.

=================================== FAILURES ===================================
_______________ [doctest] pygmt.helpers.decorators.fmt_docstring _______________
160     ...
161     ...     Parameters
162     ...     ----------
163     ...     {R}
164     ...     {J}
165     ...
166     ...     {aliases}
167     ...     '''
168     ...     pass
169     >>> print(gmtinfo.__doc__)
Differences (unified diff with -expected +actual):
    @@ -5,10 +5,11 @@
     ----------
     region : str or list
    -    *Required if this is the first plot command*.
    -    ``'xmin/xmax/ymin/ymax[+r][+uunit]'``.
    -    Specify the region of interest.
    +    *xmin/xmax/ymin/ymax*\ [**+r**\ ][**+u**\ *unit*]
    +    Specify the region of interest. This is a required argument if this 
    +    is the first plot command.
     projection : str
    -    *Required if this is the first plot command*.
    -    Select map projection.
    +    *projection*\ [*projection-specific arguments*\ ]*figure size*
    +    Select map projection. This is a required argument if this 
    +    is the first plot command.
     <BLANKLINE>
     **Aliases:**

willschlitzer · 2021-01-21T19:23:33Z

I misinterpreted the 12 xfailed as test failures then. Regardless, I can't see how this is causing a doctest failure, so I'm not sure how to fix the strings to make it pass.

seisman · 2021-01-21T21:41:25Z

I misinterpreted the 12 xfailed as test failures then.

They are "known" failures.

I can't see how this is causing a doctest failure, so I'm not sure how to fix the strings to make it pass.

You need to update these lines:

pygmt/pygmt/helpers/decorators.py

Lines 172 to 180 in 547a6fc

    
               Parameters 
        
               ---------- 
        
               region : str or list 
        
                   *Required if this is the first plot command*. 
        
                   ``'xmin/xmax/ymin/ymax[+r][+uunit]'``. 
        
                   Specify the region of interest. 
        
               projection : str 
        
                   *Required if this is the first plot command*. 
        
                   Select map projection.

pygmt/helpers/decorators.py

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

weiji14

I reckon this PR is about done, just a few more changes needed.

weiji14 · 2021-02-01T04:09:45Z

pygmt/helpers/decorators.py

@@ -15,13 +15,14 @@
 COMMON_OPTIONS = {
    "R": """\


Suggested change

"R": """\

"R": r"""\

Need to make this a raw r-string to avoid the pylint warning (W605 invalid escape sequence '\ ')

It rendered incorrectly when I would have raw strings in both COMMON_OPTIONS and the function doc strings (check out the deployment for 62e8aad at the top). My guess is some issue with a raw string with escape characters being passed into another raw string.

I see, might need to rethink this a bit then or just ignore the pylint error if it's harmless.

Should I add a pylint: disable=invalid-escape-sequence (is that the correct wording/syntax?)?

pygmt/helpers/decorators.py

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

pygmt/helpers/decorators.py

seisman · 2021-02-09T22:26:39Z

pygmt/helpers/decorators.py

+    Specify the region of interest. This is a required argument if this
+    is the first plot command.""",
+    "J": r"""projection : str
+    *projection*\ [*projection-specific arguments*\ ]\ *figure size*.


-J option is very difficult to read.

pygmt/helpers/decorators.py

seisman · 2021-02-09T22:30:55Z

pygmt/helpers/decorators.py

+    "XY": r"""xshift : str
+    [**a**\|\ **c**\|\ **f**\|\ **r**\][*xshift*].
+    Shift plot origin in x-direction.
+
+    yshift : str
+    [**a**\|\ **c**\|\ **f**\|\ **r**\][*yshift*].
+    Shift plot origin in y-direction. Full documentation is at
+    :gmt-docs:`gmt.html#xy-full`.""",


The Y option is not correctly rendered.

@seisman I tried adding blank lines to create line breaks in bc6f1e8, but that just caused tests to fail. Any idea how to fix this?

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

…common-options-doc-update

willschlitzer · 2021-02-12T07:03:42Z

This problem was fixed by @seisman in #862. Closing this PR.

Update region arguments docstring in decorators.py

7e0892b

vercel bot temporarily deployed to Preview January 2, 2021 11:53 Inactive

willschlitzer added the documentation Improvements or additions to documentation label Jan 3, 2021

Merge branch 'master' into common-options-doc-update

62e8aad

vercel bot temporarily deployed to Preview January 21, 2021 10:03 Inactive

Removing raw string from COMMON_OPTIONS

6c870fe

vercel bot temporarily deployed to Preview January 21, 2021 10:10 Inactive

willschlitzer added 2 commits January 21, 2021 10:20

Update region doc string

3793b78

Update projection doc string

81d4653

vercel bot temporarily deployed to Preview January 21, 2021 10:25 Inactive

weiji14 reviewed Jan 21, 2021

View reviewed changes

pygmt/helpers/decorators.py Outdated Show resolved Hide resolved

Merge branch 'master' into common-options-doc-update

75c8c83

vercel bot temporarily deployed to Preview January 22, 2021 19:24 Inactive

willschlitzer and others added 2 commits January 22, 2021 19:24

Update pygmt/helpers/decorators.py

cd28c78

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

Add full-stop period

0d6180f

vercel bot temporarily deployed to Preview January 22, 2021 19:30 Inactive

Fix formatting typo

96acac0

vercel bot temporarily deployed to Preview January 22, 2021 20:29 Inactive

willschlitzer added 2 commits January 22, 2021 20:33

Updating COMMON_OPTIONS test

ccae62b

Fix trailing whitespaces

30993fd

vercel bot temporarily deployed to Preview January 22, 2021 20:35 Inactive

weiji14 reviewed Feb 1, 2021

View reviewed changes

Merge branch 'master' into common-options-doc-update

a0d3c77

vercel bot temporarily deployed to Preview February 7, 2021 19:50 Inactive

weiji14 reviewed Feb 7, 2021

View reviewed changes

pygmt/helpers/decorators.py Outdated Show resolved Hide resolved

Update pygmt/helpers/decorators.py

9d207c0

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

vercel bot temporarily deployed to Preview February 8, 2021 12:47 Inactive

Update common options to use raw strings

dafc436

vercel bot temporarily deployed to Preview February 8, 2021 12:58 Inactive

Change remaining COMMON_OPTIONS to use raw strings

3a7e4ec

vercel bot temporarily deployed to Preview February 8, 2021 13:07 Inactive

Fix style errors

e432f2e

vercel bot temporarily deployed to Preview February 8, 2021 13:13 Inactive

Fix style errors

d35d7d7

vercel bot temporarily deployed to Preview February 8, 2021 13:19 Inactive

weiji14 reviewed Feb 9, 2021

View reviewed changes

pygmt/helpers/decorators.py Outdated Show resolved Hide resolved

pygmt/helpers/decorators.py Outdated Show resolved Hide resolved

willschlitzer added 6 commits February 9, 2021 07:31

Update XY doc

2fe9720

Update distcalc doc

6393047

Update interpolation doc

09bfb6d

Update perspective doc

e6ef47d

Update cores doc; remove unnecessary raw strings

a82bf6c

Merge branch 'master' into common-options-doc-update

c0a096d

vercel bot temporarily deployed to Preview February 9, 2021 07:41 Inactive

Fix trailing whitespace

af72e6f

vercel bot temporarily deployed to Preview February 9, 2021 07:47 Inactive

seisman reviewed Feb 9, 2021

View reviewed changes

Apply suggestions from code review

5459dd5

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

vercel bot temporarily deployed to Preview February 10, 2021 13:54 Inactive

willschlitzer added 2 commits February 10, 2021 13:55

Add blank lines to change render

bc6f1e8

Merge remote-tracking branch 'origin/common-options-doc-update' into …

5609b6e

…common-options-doc-update

vercel bot temporarily deployed to Preview February 10, 2021 14:01 Inactive

willschlitzer added this to the 0.3.0 milestone Feb 10, 2021

seisman mentioned this pull request Feb 11, 2021

Update the docstrings of common aliases #862

Merged

5 tasks

willschlitzer closed this Feb 12, 2021

willschlitzer deleted the common-options-doc-update branch February 12, 2021 07:03

Conversation

willschlitzer commented Jan 2, 2021

Uh oh!

willschlitzer commented Jan 21, 2021

Uh oh!

seisman commented Jan 21, 2021

Uh oh!

willschlitzer commented Jan 21, 2021

Uh oh!

seisman commented Jan 21, 2021

Uh oh!

Uh oh!

weiji14 left a comment

Choose a reason for hiding this comment

Uh oh!

weiji14 Feb 1, 2021

Choose a reason for hiding this comment

Uh oh!

willschlitzer Feb 1, 2021

Choose a reason for hiding this comment

Uh oh!

weiji14 Feb 1, 2021

Choose a reason for hiding this comment

Uh oh!

willschlitzer Feb 3, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman Feb 9, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

seisman Feb 9, 2021

Choose a reason for hiding this comment

Uh oh!

willschlitzer Feb 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

willschlitzer commented Feb 12, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

willschlitzer Feb 10, 2021 •

edited

Loading