Skip to content

Commit dff8e77

Browse files
authored
Fix the docstrings of the pygmt.end function (#3663)
1 parent 1633a18 commit dff8e77

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

pygmt/session_management.py

+5-7
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,23 @@ def begin():
1717
1818
Only meant to be used once for creating the global session.
1919
"""
20-
# On Windows, need to set GMT_SESSION_NAME to a unique value
20+
# On Windows, need to set GMT_SESSION_NAME to a unique value.
2121
if sys.platform == "win32":
2222
os.environ["GMT_SESSION_NAME"] = unique_name()
2323

2424
prefix = "pygmt-session"
2525
with Session() as lib:
2626
lib.call_module(module="begin", args=[prefix])
27-
# pygmt relies on GMT modern mode with GMT_COMPATIBILITY at version 6
27+
# PyGMT relies on GMT modern mode with GMT_COMPATIBILITY at version 6.
2828
lib.call_module(module="set", args=["GMT_COMPATIBILITY=6"])
2929

3030

3131
def end():
3232
"""
33-
Terminate GMT modern mode session and optionally produce the figure files.
33+
Terminate the GMT modern mode session created by :func:`pygmt.begin`.
3434
35-
Called after :func:`pygmt.begin` and all commands that you want included in
36-
a session. Will finalize any PostScript plots that were made in the
37-
background, convert them to the desired format (specified in
38-
``pygmt.begin``), and bring the figures to the working directory.
35+
Called after :func:`pygmt.begin` and all commands that you want included in a
36+
session. Will clean up the session directory completely.
3937
"""
4038
with Session() as lib:
4139
lib.call_module(module="end", args=[])

0 commit comments

Comments
 (0)