Updated docs, tests and code.

Author: itzpr3d4t0r

docs/reST/ref/geometry.rst

@@ -285,17 +285,15 @@
 
    .. method:: contains
 
-         | :sl:`test if a shape or point is inside the circle`
+         | :sl:`check if a shape or point is inside the circle`
          | :sg:`contains(circle, /) -> bool`
          | :sg:`contains(rect, /) -> bool`
          | :sg:`contains((x, y), /) -> bool`
          | :sg:`contains(vector2, /) -> bool`
 
-         The `contains` method tests whether a given shape or point is completely contained
-         within a `Circle` object. The function takes a single argument which can be a `Circle`,
-         `Rect`, `FRect`, or a point.
-         It returns `True` if the shape or point is completely contained, and `False` otherwise.
-
+         Checks whether a given shape or point is completely contained within the `Circle`.
+         Takes a single argument which can be a `Circle`, `Rect`, `FRect`, or a point.
+         Returns `True` if the shape or point is completely contained, and `False` otherwise.
 
          .. note::
              The shape argument must be an actual shape object (`Circle`, `Rect`, or `FRect`).

src_c/circle.c

@@ -380,20 +380,18 @@ pg_circle_contains(pgCircleObject *self, PyObject *arg)
 
     if (pgCircle_Check(arg)) {
         pgCircleBase *temp = &pgCircle_AsCircle(arg);
-        if (temp == scirc) {
-            /*a circle is always contained within itself*/
+        /*a circle is always contained within itself*/
+        if (temp == scirc)
             Py_RETURN_TRUE;
-        }
         /* a bigger circle can't be contained within a smaller circle */
-        if (temp->r > scirc->r) {
+        if (temp->r > scirc->r)
             Py_RETURN_FALSE;
-        }
 
-        double dx = temp->x - scirc->x;
-        double dy = temp->y - scirc->y;
-        double distance = sqrt(dx * dx + dy * dy);
+        const double dx = temp->x - scirc->x;
+        const double dy = temp->y - scirc->y;
+        const double dr = temp->r - scirc->r;
 
-        result = distance + temp->r <= scirc->r;
+        result = (dx * dx + dy * dy) <= (dr * dr);
     }
     else if (pgRect_Check(arg)) {
         SDL_Rect *temp = &pgRect_AsRect(arg);

src_c/doc/geometry_doc.h

@@ -15,7 +15,7 @@
 #define DOC_CIRCLE_MOVEIP "move_ip((x, y), /) -> None\nmove_ip(x, y, /) -> None\nmove_ip(vector2, /) -> None\nmoves the circle by a given amount, in place"
 #define DOC_CIRCLE_COLLIDERECT "colliderect(rect, /) -> bool\ncolliderect((x, y, width, height), /) -> bool\ncolliderect(x, y, width, height, /) -> bool\ncolliderect((x, y), (width, height), /) -> bool\nchecks if a rectangle intersects the circle"
 #define DOC_CIRCLE_COLLIDESWITH "collideswith(circle, /) -> bool\ncollideswith(rect, /) -> bool\ncollideswith((x, y), /) -> bool\ncollideswith(vector2, /) -> bool\ncheck if a shape or point collides with the circle"
-#define DOC_CIRCLE_CONTAINS "contains(circle, /) -> bool\ncontains(rect, /) -> bool\ncontains((x, y), /) -> bool\ncontains(vector2, /) -> bool\ntest if a shape or point is inside the circle"
+#define DOC_CIRCLE_CONTAINS "contains(circle, /) -> bool\ncontains(rect, /) -> bool\ncontains((x, y), /) -> bool\ncontains(vector2, /) -> bool\ncheck if a shape or point is inside the circle"
 #define DOC_CIRCLE_UPDATE "update((x, y), radius, /) -> None\nupdate(x, y, radius, /) -> None\nupdates the circle position and radius"
 #define DOC_CIRCLE_ROTATE "rotate(angle, rotation_point=Circle.center, /) -> Circle\nrotate(angle, /) -> Circle\nrotates the circle"
 #define DOC_CIRCLE_ROTATEIP "rotate_ip(angle, rotation_point=Circle.center, /) -> None\nrotate_ip(angle, /) -> None\nrotates the circle in place"

test/geometry_test.py

@@ -1199,6 +1199,10 @@ def test_contains_circle(self):
         # intersecting circle
         self.assertFalse(c.contains(c4))
 
+        # bigger circle not contained in smaller circle
+        self.assertFalse(c2.contains(c))
+        self.assertFalse(c3.contains(c4))
+
     def test_contains_point(self):
         """Ensures that the contains method correctly determines if a point is
         contained within the circle"""