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 COMMON_OPTIONS arguments to GMT standard #783

Closed
Changes from 1 commit
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
7e0892b
Update region arguments docstring in decorators.py
willschlitzer Jan 2, 2021
62e8aad
Merge branch 'master' into common-options-doc-update
willschlitzer Jan 21, 2021
6c870fe
Removing raw string from COMMON_OPTIONS
willschlitzer Jan 21, 2021
3793b78
Update region doc string
willschlitzer Jan 21, 2021
81d4653
Update projection doc string
willschlitzer Jan 21, 2021
75c8c83
Merge branch 'master' into common-options-doc-update
willschlitzer Jan 22, 2021
cd28c78
Update pygmt/helpers/decorators.py
willschlitzer Jan 22, 2021
0d6180f
Add full-stop period
willschlitzer Jan 22, 2021
96acac0
Fix formatting typo
willschlitzer Jan 22, 2021
ccae62b
Updating COMMON_OPTIONS test
willschlitzer Jan 22, 2021
30993fd
Fix trailing whitespaces
willschlitzer Jan 22, 2021
a0d3c77
Merge branch 'master' into common-options-doc-update
seisman Feb 7, 2021
9d207c0
Update pygmt/helpers/decorators.py
willschlitzer Feb 8, 2021
15b66c0
Merge branch 'master' into common-options-doc-update
willschlitzer Feb 8, 2021
dafc436
Update common options to use raw strings
willschlitzer Feb 8, 2021
3a7e4ec
Change remaining COMMON_OPTIONS to use raw strings
willschlitzer Feb 8, 2021
e432f2e
Fix style errors
willschlitzer Feb 8, 2021
d35d7d7
Fix style errors
willschlitzer Feb 8, 2021
2fe9720
Update XY doc
willschlitzer Feb 9, 2021
6393047
Update distcalc doc
willschlitzer Feb 9, 2021
09bfb6d
Update interpolation doc
willschlitzer Feb 9, 2021
e6ef47d
Update perspective doc
willschlitzer Feb 9, 2021
a82bf6c
Update cores doc; remove unnecessary raw strings
willschlitzer Feb 9, 2021
c0a096d
Merge branch 'master' into common-options-doc-update
willschlitzer Feb 9, 2021
af72e6f
Fix trailing whitespace
willschlitzer Feb 9, 2021
5459dd5
Apply suggestions from code review
willschlitzer Feb 10, 2021
bc6f1e8
Add blank lines to change render
willschlitzer Feb 10, 2021
5609b6e
Merge remote-tracking branch 'origin/common-options-doc-update' into …
willschlitzer Feb 10, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update distcalc doc
  • Loading branch information
willschlitzer committed Feb 9, 2021
commit 6393047eb67df32b50e58efce527df85f464850a
12 changes: 6 additions & 6 deletions pygmt/helpers/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@
*projection*\ [*projection-specific arguments*\ ]\ *figure size*.
Copy link
Member

Choose a reason for hiding this comment

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

-J option is very difficult to read.
image

Select map projection. This is a required argument if this
is the first plot command.""",
"B": r"""frame : str or list
"B": """frame : bool or str or list
Set map boundary frame and axes attributes.""",
"U": r"""timestamp : bool or str
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
Draw GMT time stamp logo on plot.""",
"CPT": r"""cmap : str
"CPT": """cmap : str
File name of a CPT file or ``C='color1,color2[,color3,...]'`` to
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
build a linear continuous CPT from those colors automatically.""",
"G": r"""color : str
"G": """color : str
Select color or pattern for filling of symbols or polygons. Default
is no fill.""",
"V": r"""verbose : str
"V": """verbose : str
Select verbosity level [Default is w], which modulates the messages
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
written to stderr. Choose among 7 levels of verbosity:
- **q** - Quiet, not even fatal error messages are produced
Expand All @@ -41,7 +41,7 @@
- **i** - Informational messages (same as "verbose=True")
- **c** - Compatibility warnings
- **d** - Debugging messages""",
"W": r"""pen : str
"W": """pen : str
Set pen attributes for lines or the outline of symbols.""",
"XY": r"""xshift : str
[**a**\|\ **c**\|\ **f**\|\ **r**\][*xshift*].
Expand All @@ -52,7 +52,7 @@
Shift plot origin in y-direction. Full documentation is at
:gmt-docs:`gmt.html#xy-full`.""",
"j": r"""distcalc : str
``e|f|g``.
**e**\|\ **f**\|\ **g**.
Determine how spherical distances are calculated.
- **e** - Ellipsoidal (or geodesic) mode
- **f** - Flat Earth mode
Expand Down