Skip to content

Commit

Permalink
Tiny improvements of functions strings (#2860)
Browse files Browse the repository at this point in the history
  • Loading branch information
yvonnefroehlich authored Dec 8, 2023
1 parent 3812c99 commit 6527a56
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions pygmt/helpers/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@
""",
"projection": r"""
projection : str
*projcode*\[*projparams*/]\ *width*.
*projcode*\[*projparams*/]\ *width*\ |*scale*.
Select map :doc:`projection </projections/index>`.""",
"region": r"""
region : str or list
Expand Down Expand Up @@ -426,7 +426,7 @@ def fmt_docstring(module_func):
*xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*].
Specify the :doc:`region </tutorials/basics/regions>` of interest.
projection : str
*projcode*\[*projparams*/]\ *width*.
*projcode*\[*projparams*/]\ *width*\ |*scale*.
Select map :doc:`projection </projections/index>`.
<BLANKLINE>
**Aliases:**
Expand Down
2 changes: 1 addition & 1 deletion pygmt/src/image.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ def image(self, imagefile, **kwargs):
position : str
[**g**\|\ **j**\|\ **J**\|\ **n**\|\ **x**]\ *refpoint*\ **+r**\ *dpi*\
**+w**\ [**-**]\ *width*\ [/*height*]\ [**+j**\ *justify*]\
[**+n**\ *nx*\ [/*ny*] ]\ [**+o**\ *dx*\ [/*dy*]].
[**+n**\ *nx*\ [/*ny*]]\ [**+o**\ *dx*\ [/*dy*]].
Set reference point on the map for the image.
box : bool or str
[**+c**\ *clearances*][**+g**\ *fill*][**+i**\ [[*gap*/]\ *pen*]]\
Expand Down

0 comments on commit 6527a56

Please sign in to comment.