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

Improve a few doc pages #62

Merged
merged 2 commits into from
Sep 18, 2018
Merged

Improve a few doc pages #62

merged 2 commits into from
Sep 18, 2018

Conversation

PaulWessel
Copy link
Member

Joaquim was unhappy with how some options were documented in spectrum1d, gmt2kml, and grdimage. I could not find the problem in grd2kml.

Joaquim was unhappy with how some options were documented in spectrum1d, gmt2kml, and grdimage.  I could not find the problem in grd2kml.
@@ -108,7 +108,7 @@ Optional Arguments

.. _-E:

**-E**\ [*altitude*]
**-E**
Extrude feature down to ground level [no extrusion].

.. _-F:
Copy link
Member

Choose a reason for hiding this comment

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

Need to fix also the end of -N description that ends exactly like this

appearing where %d is placed, (4) give no arguments to turn symbol labeling off; line segments will still be named. Also note that

Copy link
Member Author

Choose a reason for hiding this comment

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

Please be specific where this is since searching for this text in all *.c files returns no matches. What file are we talking about here? Your original message said grd2kml but now you say gmt2kml, but in either case I cannot find what you are listing.

Copy link
Member

Choose a reason for hiding this comment

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

It's man page of gmt2kml -N option (https://gmt.soest.hawaii.edu/doc/latest/gmt2kml.html#n)


-N[t|col |name_template|name]
    By default, if segment headers contain a -L“label string” then we use that for the name of the KML feature (polygon, line segment or set of symbols). Default names for these segments are
“Line %d” and “Point Set %d”, depending on the feature, where %d is a sequence number of
line segments within a file. Each point within a line segment will be named after the line
segment plus a sequence number. Default is simply “Point %d”. Alternatively, select one of
these options: (1) append col to supply individual symbol labels as the string formatted from
the col data column, (2) append t to let individual symbol labels be the trailing text of each
record (3) append a string that may include %d or a similar integer format to assign unique
name IDs for each feature, with the segment number (for lines and polygons) or point number
(symbols) appearing where %d is placed, (4) give no arguments to turn symbol labeling off; line
segments will still be named. Also note that 

Copy link
Member

@joa-quim joa-quim left a comment

Choose a reason for hiding this comment

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

The gmt2kml -N option ends exactly like this

...appearing where %d is placed, (4) give no arguments to turn symbol labeling off; line segments will still be named. Also note that

Fixed the chopped off sentence.
@PaulWessel PaulWessel merged commit cdca1ea into master Sep 18, 2018
@PaulWessel PaulWessel deleted the docimprove branch September 18, 2018 17:29
obaney pushed a commit to obaney/gmt that referenced this pull request Aug 18, 2021
Fixes GenericMappingTools#62 

Add a `show` argument (default to False) to savefig to open the figure
in an external viewer. Needed for scripts because `Figure.show(external=True)`
is non-blocking and would the temp figure would be deleted.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants