Skip to content

Commit

Permalink
Merge pull request #2715 from bydariogamer/docs
Browse files Browse the repository at this point in the history
Minor docs improvements
  • Loading branch information
Charlie Hayden committed Sep 12, 2021
2 parents 07d92e7 + ddce3b5 commit 32a5502
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 7 deletions.
1 change: 0 additions & 1 deletion docs/reST/ref/draw.rst
Original file line number Diff line number Diff line change
Expand Up @@ -551,7 +551,6 @@ object around the draw calls (see :func:`pygame.Surface.lock` and
.. ## pygame.draw ##
.. figure:: code_examples/draw_module_example.png
:scale: 50 %
:alt: draw module example

Example code for draw module.
Expand Down
4 changes: 2 additions & 2 deletions docs/reST/ref/rect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@

.. note ::
Rect objects cannot be used as keys in a dictionary (they are not
hashable), so they must be converted to a tuple/list.
hashable), so they must be converted to a tuple.
e.g. ``rect.collidedict({tuple(key_rect) : value})``
.. ## Rect.collidedict ##
Expand All @@ -383,7 +383,7 @@

.. note ::
Rect objects cannot be used as keys in a dictionary (they are not
hashable), so they must be converted to a tuple/list.
hashable), so they must be converted to a tuple.
e.g. ``rect.collidedictall({tuple(key_rect) : value})``
.. ## Rect.collidedictall ##
Expand Down
8 changes: 4 additions & 4 deletions src_c/doc/surface_doc.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/* Auto generated file: with makeref.py . Docs go in docs/reST/ref/ . */
#define DOC_PYGAMESURFACE "Surface((width, height), flags=0, depth=0, masks=None) -> Surface\nSurface((width, height), flags=0, Surface) -> Surface\npygame object for representing images"
#define DOC_SURFACEBLIT "blit(source, dest, area=None, special_flags=0) -> Rect\ndraw one image onto another"
#define DOC_SURFACEBLITS "blits(blit_sequence=(source, dest), ...), doreturn=1) -> [Rect, ...] or None\nblits((source, dest, area), ...)) -> [Rect, ...]\nblits((source, dest, area, special_flags), ...)) -> [Rect, ...]\ndraw many images onto another"
#define DOC_SURFACEBLITS "blits(blit_sequence=((source, dest), ...), doreturn=1) -> [Rect, ...] or None\nblits(((source, dest, area), ...)) -> [Rect, ...]\nblits(((source, dest, area, special_flags), ...)) -> [Rect, ...]\ndraw many images onto another"
#define DOC_SURFACECONVERT "convert(Surface=None) -> Surface\nconvert(depth, flags=0) -> Surface\nconvert(masks, flags=0) -> Surface\nchange the pixel format of an image"
#define DOC_SURFACECONVERTALPHA "convert_alpha(Surface) -> Surface\nconvert_alpha() -> Surface\nchange the pixel format of an image including per pixel alphas"
#define DOC_SURFACECOPY "copy() -> Surface\ncreate a new copy of a Surface"
Expand Down Expand Up @@ -65,9 +65,9 @@ pygame.Surface.blit
draw one image onto another
pygame.Surface.blits
blits(blit_sequence=(source, dest), ...), doreturn=1) -> [Rect, ...] or None
blits((source, dest, area), ...)) -> [Rect, ...]
blits((source, dest, area, special_flags), ...)) -> [Rect, ...]
blits(blit_sequence=((source, dest), ...), doreturn=1) -> [Rect, ...] or None
blits(((source, dest, area), ...)) -> [Rect, ...]
blits(((source, dest, area, special_flags), ...)) -> [Rect, ...]
draw many images onto another
pygame.Surface.convert
Expand Down

0 comments on commit 32a5502

Please sign in to comment.