Update common options in THIS_MODULE_OPTIONS and docs#5759
Update common options in THIS_MODULE_OPTIONS and docs#5759
Conversation
|
@PaulWessel, could you please clarify common option usage for a couple modules?
Also, is there a historical reason why -s is only available for output records, rather than input and/or output like -q, -d, -h, and -f? |
Yes, I cannot think of any reason -g is useful in this context.
I agree with that too.
Yes. It originated as a special -S option in grd2xyz to exclude output if a node was NaN. Then it migrated to a global common -s option in GMT 5 since there were other modules where not outputting a record if z = NaN made sense. There was no clear need for it to apply on input: If input records has NaNs GMT handles that very differently. NaNs are allowed except for in x-y coordinates I think. There is the GMT defaults IO_NAN_RECORDS [pass] that deals with how NaNs should be considered if found in input. |
PaulWessel
left a comment
There was a problem hiding this comment.
Great! Lots of little minor bugs fixed along the way as well I see.
Description of proposed changes
This PR updates erroneous contents in the
THIS_MODULE_OPTIONSmacro and ensures consistency between the macro and documentation, motivated by @PaulWessel's observation that some modules inappropriately have the -s common option without offering table output.Also includes some minor docs fixes.
Fixes #5653
Fixes #5670
Reminders