-
Notifications
You must be signed in to change notification settings - Fork 368
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
Documentation of character escape sequences in text module and Cookbook not ideal #7210
Comments
It is always true that the documentation can be improved. We try to follow this model for new changes: If some chunks of explanation (say Latex or accented characters) really is useful in more than one place, then we make a single file with extension.rst_ and we include that file in the places the content should go. This means we only have one place to maintain and fix for typos or extensions even though it appears in more than one place in the docs. Over the years we have made changes to fit this model but there are tons of places that could benefit from this treatment. Last week I added this to both grdmath and gmtmath documentation just after the description:
and that file shows some relevant images and captions that discusses Reverse Polish Notation, for instance. |
That include model is better than my idea. Would you mind me giving it a shot for the escape characters and consolidate that info into a single file? @PaulWessel - After re-reading my initial post it sounds a bit harsh/aggressive – that wasn't my intention. I know how hard it can be to document things properly and then maintaining it. If you felt this way, please accept my apologies. I just saw a possible area for improvement where I don't have to rely on your work and time to improve it but could do it myself. |
No worries Kristof, I have thick skin and did not even notice anything negative. |
Phew. Glad to hear! Do you think it is worthwhile me going ahead with this? |
Sure, I think any improvement is good. |
Description of the problem
The documentation for the character escape sequences exists in both the
text
module and in the Cookbook. Neither one is really good and I would like to improve the documentation.Identified areas for improvement:
(in no particular order)
text
, just some paragraphs down as text. Easy to overlook that powerful option this way.text
only the shorthands are given instead of the resulting characters. Would be better to have the supported characters on hand and then link to the table for the shorthand?text
? Only one place to maintain them.The issue was brought to my attention by user Andreas in the forum.
What do @GenericMappingTools/core and @GenericMappingTools/gmt-maintainers think about this? Do you consider it worthwhile? If yes, I'm happy to work on the improvement of the documentation.
The text was updated successfully, but these errors were encountered: