Skip to content

Conversation

@PaulWessel
Copy link
Member

The -g syntax was a bit awkward (had a separate -qa to change a bool value). Now we use a modifier (+a) like elsewhere. Also, we now set an alternative z-coordinate column via +ccol like elsewhere [2]. Also fixed wording and minor mistakes in the RST and synopsis.

The -g was a bit awkward (had separate -qa to change a bool value, now we use a modifier like elsewhere.  Also, set alternative z-column via +ccol like elsewhere.  Fixed wording and minor mistakes in the RST.
@PaulWessel PaulWessel added the documentation Improve documentation label Aug 10, 2021
@PaulWessel PaulWessel requested a review from maxrjones August 10, 2021 01:57
@PaulWessel PaulWessel self-assigned this Aug 10, 2021
@maxrjones maxrjones added add-changelog Add PR to the changelog deprecation Deprecating a feature labels Aug 10, 2021
@maxrjones
Copy link
Member

I find the new syntax more confusing than before (in particular the relation between z directive and +c modifier). I think this would be more similar to the syntax in other common options:
-gx|y|d|X|Y|D|z[col/]gap[+a][+n|p]

@PaulWessel
Copy link
Member Author

Let's discuss this. I see +ccol is used in several places:

Common options:

-qi[~]<rangevalues>,...+c<col>
-qo[~]<rangevalues>,...+c<col> 
-wy|a|w|d|h|m|s|c<period>[/<phase>][+c<col>]

gmtinfo:
[-T<dz>[+c<col>]]

gmtselect:
-Z<min>/<max>[+c<col>][+i][+a]

In that context, this looks similar to me:

-gx|y|z|d|X|Y|D<gap>[<unit>][+a][+c<col>][+n|p

Adding the slash if a zcol is specified means more complications in doing a long-option I think. PS. I need to read a thesis and attend a defense and then a Dr visit so will be very intermittent here today.

@maxrjones
Copy link
Member

Let's discuss this. I see +ccol is used in several places:

Common options:

-qi[~]<rangevalues>,...+c<col>
-qo[~]<rangevalues>,...+c<col> 
-wy|a|w|d|h|m|s|c<period>[/<phase>][+c<col>]

gmtinfo:
[-T<dz>[+c<col>]]

gmtselect:
-Z<min>/<max>[+c<col>][+i][+a]

In that context, this looks similar to me:

-gx|y|z|d|X|Y|D<gap>[<unit>][+a][+c<col>][+n|p

Adding the slash if a zcol is specified means more complications in doing a long-option I think. PS. I need to read a thesis and attend a defense and then a Dr visit so will be very intermittent here today.

OK, I will instead just make a couple small wording suggestions for the new syntax.

Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
Copy link
Member

@maxrjones maxrjones left a comment

Choose a reason for hiding this comment

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

Looks good after the two suggestions removing the extra | in the synopsis are resolved.

Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

add-changelog Add PR to the changelog deprecation Deprecating a feature documentation Improve documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants