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

Merged
merged 2 commits into from
Jul 27, 2020
Merged

Add common alias verbose (V) #550

merged 2 commits into from
Jul 27, 2020

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented Jul 27, 2020

Description of proposed changes

Select verbosity level [Default is w], which modulates the messages written to stderr. See https://docs.generic-mapping-tools.org/6.1/gmt.html#v-full. 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

Cherry-picked from #546.

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.

@weiji14 weiji14 added the enhancement Improving an existing feature label Jul 27, 2020
@weiji14 weiji14 mentioned this pull request Jul 27, 2020
30 tasks
@@ -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:https://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.

@weiji14 weiji14 merged commit f47a61e into master Jul 27, 2020
@weiji14 weiji14 deleted the alias/verbose branch July 27, 2020 21:55
@weiji14 weiji14 mentioned this pull request Oct 23, 2020
28 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improving an existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants