gmt icon indicating copy to clipboard operation
gmt copied to clipboard

Fix explain_array.rst_ links in docs

Open maxrjones opened this issue 4 years ago • 4 comments

Description of the problem

Currently, the documentation pages for filter1d, gmtmath, gmtregress, grdinterpolate, histogram, pshistogram, makecpt, and sample1d include doc/rst/source/explain_array.rst_, which demonstrates the use of options for creating 1-D arrays via gmtmath.

Here is an example of the generate 1D array section in the makecpt docs.

I think the 1D array section only makes sense in the gmtmath docs and would like to submit a PR with that section removed from the other modules' documentation.

maxrjones avatar Jan 04 '21 22:01 maxrjones

I agree it uses gmtmath to illustrate how to set up a series of numbers. But we do need something like this in filter1d, sample1d, etc, etc. to let people know how to to use -T. Perhaps the file could need some language to say we are illustrating the effect of -T using gmt math but that the same syntax is used throughout GMT wherever a 1-D series need to be indicated? Alternatively, introduce a much shorter explain*.rst_ file for those other modules but have it include a link to the full one for more details?

PaulWessel avatar Jan 04 '21 22:01 PaulWessel

Many of the other options that require additional explanation include references to sections of the cookbook, -r[g|p] is a good example. Is that an option? Otherwise, revising to make it more clear that the purpose is to explain -T would also work.

maxrjones avatar Jan 04 '21 23:01 maxrjones

Yes, that is a possibility. We would have to basically place most of that doc file into the general features sections for how to create 1-d series, then refer to it.

PaulWessel avatar Jan 04 '21 23:01 PaulWessel

This issue has been automatically marked as stale because it has not had activity in the last 90 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions.

stale[bot] avatar Jun 02 '21 17:06 stale[bot]