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.

Sign up for GitHub

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 common alias verbose (V) #550

Merged
merged 2 commits into from
Jul 27, 2020
Merged

Add common alias verbose (V) #550

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc6259d
Add common alias verbose (V)
weiji14 Jul 27, 2020
4d4ea9f
Merge branch 'master' into alias/verbose
weiji14 Jul 27, 2020
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
12 changes: 12 additions & 0 deletions pygmt/helpers/decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,18 @@
color : str
Select color or pattern for filling of symbols or polygons. Default
is no fill.""",
"V": """\
verbose : str
Copy link
Member

Choose a reason for hiding this comment

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

FYI, the GMT experimental long options use verbosity and spherical for -V and -j (https://github.com/GenericMappingTools/gmt/blob/master/src/gmt_init.c#L383), while GMT.jl uses verbose and spheric_dist | spherical_dist(https://www.generic-mapping-tools.org/GMT.jl/latest/#GMT.grdmask).

Copy link
Member Author

Choose a reason for hiding this comment

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

I would definitely prefer 'verbose' for V, it's similar to most command-line arguments.

As for 'j', I've merged the PR already, but could make a quick change. The GMT.jl documentation actually points to http://docs.generic-mapping-tools.org/latest/gmt.html#j-full (i.e. capital J) rather than the proper link at https://docs.generic-mapping-tools.org/latest/gmt.html#distcalc-full (notice the distcalc in the link).

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I also prefer verbose for -V.

For j, I'm OK with the names. It depends on if we want to keep consistent with other GMT projects.

Copy link
Member

Choose a reason for hiding this comment

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

FYI, I believe the GMT server is up.

Select verbosity level [Default is w], which modulates the messages
written to stderr. Choose among 7 levels of verbosity:

- **q** - Quiet, not even fatal error messages are produced
- **e** - Error messages only
- **w** - Warnings [Default]
- **t** - Timings (report runtimes for time-intensive algorthms);
- **i** - Informational messages (same as "verbose=True")
- **c** - Compatibility warnings
- **d** - Debugging messages""",
"W": """\
pen : str
Set pen attributes for lines or the outline of symbols.""",
Expand Down