Skip to content

Commit 4bf05ab

Browse files
committed
Document private members Rect2
This makes the links work nicer and the functions are documented anyway. * docs/Geometry.rst - document private Rect2 members * pygorithm/geometry/rect2.py - Minor documentation tweaks
1 parent 205ffbf commit 4bf05ab

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

docs/Geometry.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ Axis-Aligned Rectangle
9090
.. autoclass:: pygorithm.geometry.rect2.Rect2
9191
:members:
9292
:special-members:
93+
:private-members:
9394

9495

9596

pygorithm/geometry/rect2.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ def find_intersection(cls, *args, **kwargs):
373373
374374
.. note::
375375
376-
The first argument is checked with isinstance(arg, Rect2). If this is
376+
The first argument is checked with ``isinstance(arg, Rect2)``. If this is
377377
False, the first argument is assumed to be a Polygon2. If you want to
378378
use a compatible rectangle class for which this check would fail, you
379379
can call

0 commit comments

Comments
 (0)