From 1801cfd0cc9252ffe4e03b270648320252879e2c Mon Sep 17 00:00:00 2001 From: Florian Festi Date: Sun, 24 Feb 2019 13:13:34 +0100 Subject: [PATCH] API Docs: Add section about tabs --- documentation/src/api_drawing.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/documentation/src/api_drawing.rst b/documentation/src/api_drawing.rst index 24d648c..da308b7 100644 --- a/documentation/src/api_drawing.rst +++ b/documentation/src/api_drawing.rst @@ -26,6 +26,20 @@ These should probably be Edge classes. But right now they are still functions. .. automethod:: boxes.Boxes.latch .. automethod:: boxes.Boxes.handle +Tab support +........... + +Tabs are small interuptions in the border of a part to keep it in +place. They are enabled with the **tabs** parameter. All +**Edges** automatically create about two tabs. So parts like +:py:meth:`boxes.Boxes.rectangularWall` will have 8 tabs holding them +in place. Because of this developers often don't need to be concerned +about tabs. But some part may be complitely drawn by low level Turtle +Graphics commands. For those both :py:meth:`boxes.Boxes.edge` and +:py:meth:`boxes.Boxes.corner` do support a **tabs** parameter. In +addition the length of the line segments in :py:meth:`boxes.Boxes.poyline` can +be given as a tuple **(length, tabs)**. + Draw Commands -------------