GenericMappingTools / gmt

The Generic Mapping Tools
https://www.generic-mapping-tools.org
Other
847 stars 355 forks source link

Maybe use modern names in listing of core modern modules #8058

Open PaulWessel opened 10 months ago

PaulWessel commented 10 months ago

At the moment, we list all the core modules this way:

core

Since the documented form for using any gmt module is via arguments to the single program gmt:

gmt modulename ...options...

I suggest we simple drop the leading gmt in the module names since that is already covered by the driver gmt. Yes, I know there are folks like @joa-quim and old-time users who does not use the documented form but since we have a separate listing for classic modules I think the modern listing should be slimmer, just like there is no leading ps on plotting modules. It should help people adjust to modern mode quicker, which is desired.

Wish to discuss this a bit, perhaps?

seisman commented 10 months ago

For modules like gmtinfo, classic mode and modern mode use the same ReST file gmtinfo.rst. We can change gmtinfo to info but users who click the link will open the link (http://docs.generic-mapping-tools.org/dev/gmtinfo.html) will still see the name gmtinfo.

PaulWessel commented 10 months ago

I guess the solution there is the same we do for psimage vs image: A near-empty psimage.rstthat includes image.rst? I just think propagating module names starting with gmt looks odd. Old-timers can do whatever, but rookies should use gmt info and not gmt gmtinfo. Gurus can build those links so they can type gmtinfo but we should stay on the narrow path for modern mode.

PaulWessel commented 10 months ago

Let's broaden this discussion to @GenericMappingTools/gmt-team to get input. My point here is that GMT modern mode is the main GMT way going forward, so the listing of modern mode modules should not have a leading gmt in the name since all GMT modules are just functions than needs to be called by gmt (ignoring older gurus who don't want to type gmt module). Given that, makes little sense to me to have man pages that says gmtinfo, gmtspatial, etc. in modern mode. There is a separate web page with the classic module names and there we keep things the same. The solution involves adding some almost empty *rst files like we do for the ps and no-ps version of modules like psbasemap.

anbj commented 10 months ago

I agree. It just clutters.

joa-quim commented 10 months ago

Maybe it's not only that stubborn guru but many Win users that don't need to prefix with gmt. Anyway, we used to prefix the modules with gmt to indicate that they work on tables and grd to indicate grid operations. It feels weird to me seeing modules called get, set, info, 2kml , ...

PaulWessel commented 8 months ago

Well, another important reason for the gmt driver was namespace pollution. If you want to run pstext then you need to deal with Seismic Unix who also have pstext etc. That is the real killer and a really good reason we all should start with gmt I think. Your point about get, set, etc. is still valid though.