Skip to content

Commit 4d04868

Browse files
committed
Improve docstrings
1 parent cb23c57 commit 4d04868

1 file changed

Lines changed: 3 additions & 9 deletions

File tree

pygmt/src/scalebar.py

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,9 @@ def scalebar( # noqa: PLR0913
3939
Specify the location of the scale bar. See :class:`pygmt.params.Position` for
4040
more details.
4141
length
42-
Length of the scale bar in km. You can append different units to the length,
43-
which are:
44-
45-
- **e**: meters
46-
- **f**: feet
47-
- **k**: kilometers
48-
- **M**: statute mile
49-
- **n**: nautical miles
50-
- **u**: US Survey foot
42+
Length of the scale bar in km. Append a suffix to specify different units. Valid
43+
units are: **e**: meters; **f**: feet; **k**: kilometers; **M**: statute mile;
44+
**n**: nautical miles; **u**: US Survey foot.
5145
scale_position
5246
Specify the location where on a geographic map the scale applies. It can be:
5347

0 commit comments

Comments
 (0)