Skip to content

Commit 6094d41

Browse files
committed
Add notes on the structure of the docs.
1 parent 0a38915 commit 6094d41

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

why/doc_structure.txt

+15-15
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ I remember reading somewhere that documentation should have three sections:
2222
- Installation
2323
"Glooey is easy to install"
2424

25-
- Widget comparison
26-
2725
- Getting started
2826
- imports
2927
- pyglet
@@ -69,24 +67,26 @@ I remember reading somewhere that documentation should have three sections:
6967
- Widget.__init__()
7068
- nested classes
7169

72-
- The widget hierarchy
70+
- Under the hood
71+
72+
- The widget hierarchy
7373

74-
- How drawing works
75-
- In order to be drawn, a widget needs:
76-
- rect (see "How repacking works")
77-
- group (see "How regrouping works")
78-
- batch (comes from the root of the widget hierarchy)
74+
- How drawing works
75+
- In order to be drawn, a widget needs:
76+
- rect (see "How repacking works")
77+
- group (see "How regrouping works")
78+
- batch (comes from the root of the widget hierarchy)
7979

80-
- draw()
81-
- undraw()
82-
- hide()
83-
- unhide()
80+
- draw()
81+
- undraw()
82+
- hide()
83+
- unhide()
8484

85-
- How repacking works
85+
- How repacking works
8686

87-
- How regrouping works
87+
- How regrouping works
8888

89-
- How mouse events work
89+
- How mouse events work
9090

9191
- Making widgets from scratch
9292

0 commit comments

Comments
 (0)