Skip to content

Commit 5b96912

Browse files
committed
Improved interface.py docstring
1 parent 20f56bd commit 5b96912

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/gdpc/interface.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
"""Provides direct wrappers for the endpoints of the GDMC HTTP interface.
22
3-
These functions are quite low-level. It is recommended to use the higher-level
4-
:class:`.editor.Editor` class instead.
3+
These functions are quite low-level. If possible, it is recommended to use the higher-level
4+
:class:`.Editor` class instead.
5+
However, some GDMC HTTP interface features that this module wraps may not be supported by
6+
``Editor`` yet. You may find this module useful for those.
57
"""
68

79

0 commit comments

Comments
 (0)