Update the one-sentence description of wrappers to match upstream documentation #3857
Conversation
seisman
added
documentation
| @@ -1,5 +1,5 @@ | |||
| """ | |||
| solar - Plot day-night terminators and twilight. | |||
| solar - Plot day-light terminators and other sunlight parameters. | |||
There was a problem hiding this comment.
The upstream documentation uses "day-light terminators" (https://docs.generic-mapping-tools.org/latest/solar.html), but sometimes it also uses "day-night" terminators.
It seems "day-night" is correct and there is an upstream typo, right?
There was a problem hiding this comment.
Should be day-night in my opinion, day-light does not make sense to me.
There was a problem hiding this comment.
I agree that the formulations on this in the GMT and PyGMT docs and examples are currently inconsistent and definitely confusing.
I feel that the idea was/ is that "day-light terminators" is the summary of all four options for the terminator parameter, i.e. day-night terminator as well as the civil, nautical and astronomical twilights.
There was a problem hiding this comment.
"day-light terminators" is the summary of all four options for the
terminatorparameter, i.e. day-night terminator as well as the civil, nautical and astronomical twilights.
It makes sense to me, so I think the GMT documentation is correct, right?
There was a problem hiding this comment.
Hm. I think it is not directly wrong, but I do not know if this is an official formulation. And I am ab it wondering if this is directly clear for users. At least I needed some time to get it.
BTW we should also be consistently use either day-night terminator or day/night terminator.
There was a problem hiding this comment.
Hm. I think it is not directly wrong, but I do not know if this is an official formulation. And I am ab it wondering if this is directly clear for users. At least I needed some time to get it.
The term has been in the GMT documentation for many years and no one complains about it, so maybe it's the correct term.
BTW we should also be consistently use either day-night terminator or day/night terminator.
"day/night terminator" is not used anywhere. Am I missing something?
There was a problem hiding this comment.
In line 52 we use currently "day_night": Day/night terminator
michaelgrund
added
final review call
| @@ -1,5 +1,5 @@ | |||
| """ | |||
| solar - Plot day-night terminators and twilight. | |||
| solar - Plot day-light terminators and other sunlight parameters. | |||
There was a problem hiding this comment.
In line 52 we use currently "day_night": Day/night terminator
| Plot base maps and frames. | ||
| Creates a basic or fancy basemap with axes, fill, and titles. Several |
There was a problem hiding this comment.
Maybe we should consistently use either "basemap" or "base map".
seisman
removed
the
final review call
GMT documentation: https://docs.generic-mapping-tools.org/latest/modules.html