Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update formatting for input values to gmt.conf parameters in documentation #4820

Closed
maxrjones opened this issue Feb 17, 2021 · 2 comments · Fixed by #4834
Closed

Update formatting for input values to gmt.conf parameters in documentation #4820

maxrjones opened this issue Feb 17, 2021 · 2 comments · Fixed by #4834
Labels
documentation Improve documentation good first issue Good for newcomers help wanted We need some help!

Comments

@maxrjones
Copy link
Member

maxrjones commented Feb 17, 2021 •
edited
Loading

Description of the problem

In most of the gmt.conf documentation, the allowed (non-numeric) values for each parameter are bolded. There are some parameters that do not follow this convention. For example, in GMT_EXTRAPOLATE_VAL,

Choose among ‘NaN’, ‘extrap’ or ‘extrapval,val’ (without quotes)

should be

choose among NaN, extrap, and extrap,val.

and in GMT_INTERPOLATE,

Determines if linear (linear), Akima’s spline (akima), natural cubic spline (cubic) or no interpolation (none) should be used for 1-D interpolations in various programs [akima].

should be

Determines if linear (linear), Akima’s spline (akima), natural cubic spline (cubic) or no interpolation (none) should be used for 1-D interpolations in various programs [akima].
@maxrjones maxrjones added help wanted We need some help! good first issue Good for newcomers documentation Improve documentation labels Feb 17, 2021
@maxrjones
Copy link
Member Author

This would be a really good first issue if anyone's interested in reviewing the gmt.conf documentation (just comment here that you'd like to work on it). The needed resources are in the restructuredText Cheatsheet and the contributing guide (and questions are welcome).

@gd-a
Copy link
Contributor

gd-a commented Feb 19, 2021

started

@gd-a gd-a mentioned this issue Feb 19, 2021
Merged
maxrjones pushed a commit that referenced this issue Feb 23, 2021
@gd-a
Update gmt.conf.rst (#4834)
6bc15cb 
* Update gmt.conf.rst

Updates the gmt.conf documentation so that the defaults values are all included in brackets and the allowed primary values for each parameter are **bolded**. Fixes #4820 and Fixes #4822.

* Update doc/rst/source/gmt.conf.rst

Co-authored-by: Meghan Jones <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improve documentation good first issue Good for newcomers help wanted We need some help!
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update gmt.conf.rst
2 participants
@maxrjones @gd-a