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

Grdcontour's long alias for G (label_placement) is not properly documented #622

Closed
weiji14 opened this issue Sep 20, 2020 · 2 comments
Closed
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@weiji14
Copy link
Member

weiji14 commented Sep 20, 2020

Description of the problem

Documentation for grdcontour uses the common alias {G} which should be a custom one for 'label_placement'. But this incorrectly points to the common alias for color (G):

"G": """\
color : str
Select color or pattern for filling of symbols or polygons. Default
is no fill.""",

The fix shouldn't be too hard, just need to change the line {G} above to the full documentation at https://docs.generic-mapping-tools.org/6.1/grdcontour.html#g.

label_placement : str
    ``[d|f|n|l|L|x|X]params``.
    The required argument controls the placement of labels along the quoted lines. Choose among five controlling algorithms:
    ...

Make sure you wrap the docstring to 79 characters as per #384!

System information

Please paste the output of python -c "import pygmt; pygmt.show_versions()":

pygmt: v0.2.0
@weiji14 weiji14 added good first issue Good for newcomers documentation Improvements or additions to documentation labels Sep 20, 2020
@weiji14 weiji14 changed the title Grdcontour's long alias for G is label_placement not properly documented Grdcontour's long alias for G (label_placement) is not properly documented Sep 20, 2020
@seisman seisman mentioned this issue Oct 23, 2020
14 tasks
@seisman
Copy link
Member

seisman commented Nov 4, 2020

The -G option is really complicated. Perhaps we can just write a one-sentence description and then link it to the GMT module documentation. It's not perfect, but at least it's better than the current wrong description.

@willschlitzer
Copy link
Contributor

Can we close this issue now that the -G alias has been explained in the linked PR by @seisman ?

@seisman seisman closed this as completed Jan 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants