diff --git a/pygmt/src/shift_origin.py b/pygmt/src/shift_origin.py index b722dd80b96..200555b8f73 100644 --- a/pygmt/src/shift_origin.py +++ b/pygmt/src/shift_origin.py @@ -15,15 +15,15 @@ def shift_origin( This method shifts the plot origin relative to the current origin by *xshift* and *yshift* in x and y directions, respectively. Optionally, append the length unit (**c** for centimeters, **i** for inches, or **p** for points) to the shifts. - Default unit if not explicitly given is **c**, but can be changed to other units - via :gmt-term:`PROJ_LENGTH_UNIT`. + Default unit if not explicitly given is **c**, but can be changed to other units via + :gmt-term:`PROJ_LENGTH_UNIT`. For *xshift*, a special character **w** can also be used, which represents the bounding box **width** of the previous plot. The full syntax is - [[±][*f*]\ **w**\ [/\ *d*\ ]±]\ *xoff*, where optional signs, factor *f* and - divisor *d* can be used to compute an offset that may be adjusted further by - ±\ *xoff*. Assuming that the previous plot has a width of 10 - centimeters, here are some example values for *xshift*: + [[±][*f*]\ **w**\ [/\ *d*\ ]±]\ *xoff*, where optional signs, factor *f* and divisor + *d* can be used to compute an offset that may be adjusted further by ±\ *xoff*. + Assuming that the previous plot has a width of 10 centimeters, here are some example + values for *xshift*: - ``"w"``: x-shift is 10 cm - ``"w+2c"``: x-shift is 10+2=12 cm