Skip to content

Commit

Permalink
Merge pull request #2024 from Temmie3754/docs
Browse files Browse the repository at this point in the history
Fix cursor doc formatting and improve consistency
  • Loading branch information
MyreMylar authored Mar 16, 2023
2 parents 7075280 + 46c539c commit 545b99a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
5 changes: 3 additions & 2 deletions docs/reST/ref/cursors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@ The following strings can be converted into cursor bitmaps with
correct size for the given width and height. Otherwise an exception is raised.

.. method:: copy

| :sl:`copy the current cursor`
| :sg:`copy() -> Cursor`
Expand All @@ -223,7 +224,7 @@ The following strings can be converted into cursor bitmaps with
.. attribute:: type

| :sl:`Gets the cursor type`
| :sl:`get the cursor type`
| :sg:`type -> string`
The type will be ``"system"``, ``"bitmap"``, or ``"color"``.
Expand All @@ -232,7 +233,7 @@ The following strings can be converted into cursor bitmaps with
.. attribute:: data

| :sl:`Gets the cursor data`
| :sl:`get the cursor data`
| :sg:`data -> tuple`
Returns the data that was used to create this cursor object, wrapped up in a tuple.
Expand Down
6 changes: 3 additions & 3 deletions src_c/doc/cursors_doc.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
#define DOC_CURSORS_COMPILE "compile(strings, black='X', white='.', xor='o') -> data, mask\ncreate binary cursor data from simple strings"
#define DOC_CURSORS_LOADXBM "load_xbm(cursorfile) -> cursor_args\nload_xbm(cursorfile, maskfile) -> cursor_args\nload cursor data from an XBM file"
#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"
#define DOC_CURSORS_CURSOR_COPY ""
#define DOC_CURSORS_CURSOR_TYPE "type -> string\nGets the cursor type"
#define DOC_CURSORS_CURSOR_DATA "data -> tuple\nGets the cursor data"
#define DOC_CURSORS_CURSOR_COPY "copy() -> Cursor\ncopy the current cursor"
#define DOC_CURSORS_CURSOR_TYPE "type -> string\nget the cursor type"
#define DOC_CURSORS_CURSOR_DATA "data -> tuple\nget the cursor data"

0 comments on commit 545b99a

Please sign in to comment.