Skip to content

Update format for default values in gmt.conf documentation #4822

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
Closed
maxrjones opened this issue Feb 17, 2021 · 3 comments · Fixed by #4834
Closed

Update format for default values in gmt.conf documentation #4822

maxrjones opened this issue Feb 17, 2021 · 3 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

Description of the problem

In the gmt.conf documentation, the default values are given in brackets [ ]. For most parameters, the brackets contain the default value (e.g., [pdf]) rather than stating "[default]" and there is no text preceding the default value (e.g., [pdf] rather than [default is pdf]). There are a few inconsistencies in the application of this convention. Here are a few examples:

COLOR_MODEL - add "[none]" to the end
COLOR_SET - change "[default, which is #0072BD,#D95319,#EDB120,#7E2F8E,#77AC30,#4DBEEE,#A2142F]" to "[#0072BD,#D95319,#EDB120,#7E2F8E,#77AC30,#4DBEEE,#A2142F]"
GMT_EXTRAPLATE_VAL - change "[Default]" to "[NaN]"
@maxrjones maxrjones added help wanted We need some help! good first issue Good for newcomers documentation Improve documentation labels Feb 17, 2021
@gd-a
Copy link
Contributor

gd-a commented Feb 19, 2021

started

@gd-a
Copy link
Contributor

gd-a commented Feb 19, 2021

Ok, I've "commit" changes to a certain point ... where it is and how do I push it to "pull request" ?

@maxrjones
Copy link
Member Author

Here's some instructions for the pull request workflow: https://www.asmeurer.com/git-workflow/.

@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