From 6527a5638faa2160b8db1d3a915ff4f2d67f51ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yvonne=20Fr=C3=B6hlich?= <94163266+yvonnefroehlich@users.noreply.github.com> Date: Fri, 8 Dec 2023 10:06:17 +0100 Subject: [PATCH] Tiny improvements of functions strings (#2860) --- pygmt/helpers/decorators.py | 4 ++-- pygmt/src/image.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py index dbb20b7731d..8a85686f786 100644 --- a/pygmt/helpers/decorators.py +++ b/pygmt/helpers/decorators.py @@ -269,7 +269,7 @@ """, "projection": r""" projection : str - *projcode*\[*projparams*/]\ *width*. + *projcode*\[*projparams*/]\ *width*\ |*scale*. Select map :doc:`projection `.""", "region": r""" region : str or list @@ -426,7 +426,7 @@ def fmt_docstring(module_func): *xmin/xmax/ymin/ymax*\ [**+r**][**+u**\ *unit*]. Specify the :doc:`region ` of interest. projection : str - *projcode*\[*projparams*/]\ *width*. + *projcode*\[*projparams*/]\ *width*\ |*scale*. Select map :doc:`projection `. **Aliases:** diff --git a/pygmt/src/image.py b/pygmt/src/image.py index cc26564e8d3..951033af255 100644 --- a/pygmt/src/image.py +++ b/pygmt/src/image.py @@ -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*]]\