Skip to content

Commit

Permalink
Rewrap to 88 characters
Browse files Browse the repository at this point in the history
  • Loading branch information
seisman committed Jan 5, 2024
1 parent 6d6a789 commit 1148c88
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions pygmt/src/shift_origin.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1148c88

Please sign in to comment.