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.

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

Update gmt.conf.rst #4834

Merged
merged 18 commits into from
Feb 23, 2021
Merged

Update gmt.conf.rst #4834

merged 18 commits into from
Feb 23, 2021

Conversation

gd-a
Copy link
Contributor

@gd-a gd-a commented Feb 19, 2021

Description of proposed changes

Updates the gmt.conf documentation so that the defaults values are all included in brackets and the allowed (non-numeric) values for each parameter are bolded.

Fixes #4820
Fixes #4822

updated up to IO_SEGMENT_MARKER

stopped before **IO_SEGMENT_MARKER**
@maxrjones
Copy link
Member

Thanks for starting on this, @gd-a! For future PRs, please include a full description of the proposed changes (even if they are already detailed in an issue). I've edited the description of this PR as an example. Full descriptions in the PRs are helpful because they simplify tracking of changes and make it easier for people who get email notifications about new pull requests. The fixes #____ is particularly helpful because it enables GitHub to automatically close issues when PRs get merged into the code base.

**Description of proposed changes**

Updates the gmt.conf documentation so that the defaults values are all included in brackets and the allowed (non-numeric) values for each parameter are **bolded**.

Fixes #4820 
Fixes #4822 

parameters in **bold** and standard format for default values `[*default is **x**]`
@gd-a
Copy link
Contributor Author

gd-a commented Feb 20, 2021

I think I submitted the full version

doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
@@ -89,11 +89,11 @@ COLOR Parameters
in CMYK but interpolates in RGB).
Copy link
Member

@maxrjones maxrjones Feb 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

L86: change from
are: **none** (default: use whatever the **COLOR_MODEL** setting in the
to
to are **none** (use whatever the **COLOR_MODEL** setting in the

doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
@joa-quim
Copy link
Member

[default is black])

Yes, agree, 'default is' should be normal font. No point in italicize it.

@maxrjones
Copy link
Member

[default is black])

Yes, agree, 'default is' should be normal font. No point in italicize it.

@gd-a, please replace the instances of *default is* with default is.

gd-a and others added 6 commits February 20, 2021 14:36
Fixes #4820
Fixes #4822

[*default is* **1950**] > [default is **1950**]
doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
doc/rst/source/gmt.conf.rst Outdated Show resolved Hide resolved
@gd-a
Copy link
Contributor Author

gd-a commented Feb 23, 2021

@meghanrjones : all your suggestions have been committed.

@maxrjones
Copy link
Member

This is great, thanks @gd-a! The only parameter that remains different from the others is COLOR_MODEL. It should be good to go after that is updated. If there's a reason why you think it should stay as is, please feel free to post.

@gd-a
Copy link
Contributor Author

gd-a commented Feb 23, 2021

The only parameter that remains different from the others is COLOR_MODEL.

How do you want it ?

@maxrjones
Copy link
Member

The only parameter that remains different from the others is COLOR_MODEL.

How do you want it ?

See this comment: https://github.com/GenericMappingTools/gmt/pull/4834/files#r579679911 and this suggestion: https://github.com/GenericMappingTools/gmt/pull/4834/files#r579680017

@maxrjones maxrjones merged commit 6bc15cb into GenericMappingTools:master Feb 23, 2021
@welcome
Copy link

welcome bot commented Feb 23, 2021

🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉

We hope that this was a good experience for you. Let us know if there is any way that the contributing process could be improved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants