Skip to content

Commit 90b744a

Browse files
committed
Explain ignore_widths in docstring
Related: #781
1 parent d45b9b0 commit 90b744a

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

boxes/__init__.py

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2437,6 +2437,22 @@ def rectangularWall(self, x, y, edges="eeee",
24372437
independent of the width of the edge (positive y move to the "inside"
24382438
of the wall, negative y move over the edge).
24392439
2440+
ignore_widths extends adjacent edges to cover for the width. The
2441+
diagram below shows where edges are extended for each number. Note
2442+
that for edges from two parts to still match this needs to be done
2443+
on both sides and both parts need to use same edge or at least an
2444+
edge with the same width.
2445+
2446+
::
2447+
4--3
2448+
5 2
2449+
| |
2450+
6 1
2451+
7--0
2452+
2453+
e.g. if four rectangularWalls use "s" edges on the bottom, the side
2454+
edges can be extended to the bottom with [1, 6].
2455+
24402456
:param x: width
24412457
:param y: height
24422458
:param edges: (Default value = "eeee") bottom, right, top, left

0 commit comments

Comments
 (0)