Skip to content

Commit 545b99a

Browse files
authored
Merge pull request #2024 from Temmie3754/docs
Fix cursor doc formatting and improve consistency
2 parents 7075280 + 46c539c commit 545b99a

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

docs/reST/ref/cursors.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,7 @@ The following strings can be converted into cursor bitmaps with
214214
correct size for the given width and height. Otherwise an exception is raised.
215215

216216
.. method:: copy
217+
217218
| :sl:`copy the current cursor`
218219
| :sg:`copy() -> Cursor`
219220
@@ -223,7 +224,7 @@ The following strings can be converted into cursor bitmaps with
223224
224225
.. attribute:: type
225226

226-
| :sl:`Gets the cursor type`
227+
| :sl:`get the cursor type`
227228
| :sg:`type -> string`
228229
229230
The type will be ``"system"``, ``"bitmap"``, or ``"color"``.
@@ -232,7 +233,7 @@ The following strings can be converted into cursor bitmaps with
232233
233234
.. attribute:: data
234235

235-
| :sl:`Gets the cursor data`
236+
| :sl:`get the cursor data`
236237
| :sg:`data -> tuple`
237238
238239
Returns the data that was used to create this cursor object, wrapped up in a tuple.

src_c/doc/cursors_doc.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
#define DOC_CURSORS_COMPILE "compile(strings, black='X', white='.', xor='o') -> data, mask\ncreate binary cursor data from simple strings"
44
#define DOC_CURSORS_LOADXBM "load_xbm(cursorfile) -> cursor_args\nload_xbm(cursorfile, maskfile) -> cursor_args\nload cursor data from an XBM file"
55
#define DOC_CURSORS_CURSOR "Cursor(size, hotspot, xormasks, andmasks) -> Cursor\nCursor(hotspot, surface) -> Cursor\nCursor(constant) -> Cursor\nCursor(Cursor) -> Cursor\nCursor() -> Cursor\npygame object representing a cursor"
6-
#define DOC_CURSORS_CURSOR_COPY ""
7-
#define DOC_CURSORS_CURSOR_TYPE "type -> string\nGets the cursor type"
8-
#define DOC_CURSORS_CURSOR_DATA "data -> tuple\nGets the cursor data"
6+
#define DOC_CURSORS_CURSOR_COPY "copy() -> Cursor\ncopy the current cursor"
7+
#define DOC_CURSORS_CURSOR_TYPE "type -> string\nget the cursor type"
8+
#define DOC_CURSORS_CURSOR_DATA "data -> tuple\nget the cursor data"

0 commit comments

Comments
 (0)