Skip to content

Commit 5ffff79

Browse files
4B796C65@gmail.com4B796C65@gmail.com
authored andcommitted
Docs and changelog updated. Could be release soon.
1 parent aa75186 commit 5ffff79

36 files changed

+2839
-2081
lines changed

CHANGELOG.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
1.1.1
2+
* map submodule added with AStar class and quickFOV function
3+
* new Typewriter class
4+
* most console functions can use Python-style negative indexes now
5+
* new App.runOnce method
6+
* rectangle geometry is less strict
17

28
1.1.0
39
* KeyEvent.keyname is now KeyEvent.key

docs/api-objects.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,9 @@ tdl.map tdl.map-module.html
4949
tdl.map.quickFOV tdl.map-module.html#quickFOV
5050
tdl.map.__package__ tdl.map-module.html#__package__
5151
tdl.map._getFOVType tdl.map-module.html#_getFOVType
52+
tdl.map._FOVTYPES tdl.map-module.html#_FOVTYPES
5253
tdl.Console tdl.Console-class.html
54+
tdl._MetaConsole._normalizeRect tdl._MetaConsole-class.html#_normalizeRect
5355
tdl.Console._setChar tdl.Console-class.html#_setChar
5456
tdl._MetaConsole.height tdl._MetaConsole-class.html#height
5557
tdl._MetaConsole.getSize tdl._MetaConsole-class.html#getSize
@@ -58,13 +60,13 @@ tdl._MetaConsole.width tdl._MetaConsole-class.html#width
5860
tdl._MetaConsole.blit tdl._MetaConsole-class.html#blit
5961
tdl.Console.__init__ tdl.Console-class.html#__init__
6062
tdl.Console._newConsole tdl.Console-class.html#_newConsole
63+
tdl._MetaConsole.console tdl._MetaConsole-class.html#console
6164
tdl._MetaConsole.__contains__ tdl._MetaConsole-class.html#__contains__
6265
tdl._MetaConsole.drawChar tdl._MetaConsole-class.html#drawChar
63-
tdl._MetaConsole.drawFrame tdl._MetaConsole-class.html#drawFrame
66+
tdl.Console.__del__ tdl.Console-class.html#__del__
6467
tdl.Console.__repr__ tdl.Console-class.html#__repr__
6568
tdl.Console._translate tdl.Console-class.html#_translate
66-
tdl._MetaConsole._normalizeRect tdl._MetaConsole-class.html#_normalizeRect
67-
tdl.Console.__del__ tdl.Console-class.html#__del__
69+
tdl._MetaConsole.drawFrame tdl._MetaConsole-class.html#drawFrame
6870
tdl.Console._replace tdl.Console-class.html#_replace
6971
tdl.Console._as_parameter_ tdl.Console-class.html#_as_parameter_
7072
tdl.Console._setCharBatch tdl.Console-class.html#_setCharBatch
@@ -93,7 +95,7 @@ tdl._MetaConsole.drawStr tdl._MetaConsole-class.html#drawStr
9395
tdl._MetaConsole.width tdl._MetaConsole-class.html#width
9496
tdl._MetaConsole.blit tdl._MetaConsole-class.html#blit
9597
tdl.Window.__init__ tdl.Window-class.html#__init__
96-
tdl.Window.console tdl.Window-class.html#console
98+
tdl._MetaConsole.console tdl._MetaConsole-class.html#console
9799
tdl._MetaConsole.__contains__ tdl._MetaConsole-class.html#__contains__
98100
tdl.Window.drawChar tdl.Window-class.html#drawChar
99101
tdl._MetaConsole._normalizeRect tdl._MetaConsole-class.html#_normalizeRect
@@ -115,6 +117,7 @@ tdl._MetaConsole.height tdl._MetaConsole-class.html#height
115117
tdl._MetaConsole.getSize tdl._MetaConsole-class.html#getSize
116118
tdl._MetaConsole.width tdl._MetaConsole-class.html#width
117119
tdl._MetaConsole.blit tdl._MetaConsole-class.html#blit
120+
tdl._MetaConsole.console tdl._MetaConsole-class.html#console
118121
tdl._MetaConsole.__contains__ tdl._MetaConsole-class.html#__contains__
119122
tdl._MetaConsole.drawChar tdl._MetaConsole-class.html#drawChar
120123
tdl._MetaConsole.drawFrame tdl._MetaConsole-class.html#drawFrame
@@ -123,6 +126,7 @@ tdl._MetaConsole._normalizePoint tdl._MetaConsole-class.html#_normalizePoint
123126
tdl._MetaConsole.drawRect tdl._MetaConsole-class.html#drawRect
124127
tdl._MetaConsole.drawStr tdl._MetaConsole-class.html#drawStr
125128
tdl._MetaConsole.scroll tdl._MetaConsole-class.html#scroll
129+
tdl._MetaConsole.getChar tdl._MetaConsole-class.html#getChar
126130
tdl.event.App tdl.event.App-class.html
127131
tdl.event.App.suspend tdl.event.App-class.html#suspend
128132
tdl.event.App.ev_MOUSEUP tdl.event.App-class.html#ev_MOUSEUP
@@ -211,12 +215,8 @@ tdl.event.Quit tdl.event.Quit-class.html
211215
tdl.event.Event.__repr__ tdl.event.Event-class.html#__repr__
212216
tdl.event.Quit.type tdl.event.Quit-class.html#type
213217
tdl.map.AStar tdl.map.AStar-class.html
218+
tdl.map.AStar._callback tdl.map.AStar-class.html#_callback
214219
tdl.map.AStar.__del__ tdl.map.AStar-class.html#__del__
215220
tdl.map.AStar.getPath tdl.map.AStar-class.html#getPath
221+
tdl.map.AStar._as_parameter_ tdl.map.AStar-class.html#_as_parameter_
216222
tdl.map.AStar.__init__ tdl.map.AStar-class.html#__init__
217-
tdl.map.Dijkstra tdl.map.Dijkstra-class.html
218-
tdl.map.Dijkstra.getPathFrom tdl.map.Dijkstra-class.html#getPathFrom
219-
tdl.map.Dijkstra.__del__ tdl.map.Dijkstra-class.html#__del__
220-
tdl.map.Dijkstra.getPathTo tdl.map.Dijkstra-class.html#getPathTo
221-
tdl.map.Dijkstra.setPole tdl.map.Dijkstra-class.html#setPole
222-
tdl.map.Dijkstra.__init__ tdl.map.Dijkstra-class.html#__init__

docs/class-tree.html

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ <h1 class="epydoc">Class Hierarchy</h1>
6161
<li> <strong class="uidlink">object</strong>:
6262
<em class="summary">The most base type</em>
6363
<ul>
64-
<li> <strong class="uidlink"><a href="tdl.map.AStar-class.html">tdl.map.AStar</a></strong>
64+
<li> <strong class="uidlink"><a href="tdl.map.AStar-class.html">tdl.map.AStar</a></strong>:
65+
<em class="summary">A* pathfinder</em>
6566
</li>
6667
<li> <strong class="uidlink"><a href="tdl.event.App-class.html">tdl.event.App</a></strong>:
6768
<em class="summary">Application framework.</em>
@@ -79,9 +80,8 @@ <h1 class="epydoc">Class Hierarchy</h1>
7980
</li>
8081
</ul>
8182
</li>
82-
<li> <strong class="uidlink"><a href="tdl.map.Dijkstra-class.html">tdl.map.Dijkstra</a></strong>
83-
</li>
84-
<li> <strong class="uidlink"><a href="tdl.event.Event-class.html">tdl.event.Event</a></strong>
83+
<li> <strong class="uidlink"><a href="tdl.event.Event-class.html">tdl.event.Event</a></strong>:
84+
<em class="summary">Base Event class.</em>
8585
<ul>
8686
<li> <strong class="uidlink"><a href="tdl.event.KeyEvent-class.html">tdl.event.KeyEvent</a></strong>
8787
<ul>
@@ -111,15 +111,17 @@ <h1 class="epydoc">Class Hierarchy</h1>
111111
</li>
112112
</ul>
113113
</li>
114-
<li> <strong class="uidlink"><a href="tdl.Typewriter-class.html">tdl.Typewriter</a></strong>
114+
<li> <strong class="uidlink"><a href="tdl.Typewriter-class.html">tdl.Typewriter</a></strong>:
115+
<em class="summary">Converts a console into a scrolling text log that respects special
116+
characters.</em>
115117
</li>
116118
<li> <strong class="uidlink"><a href="tdl._MetaConsole-class.html">tdl._MetaConsole</a></strong>:
117119
<em class="summary">Contains methods shared by both the <a
118120
href="tdl.Console-class.html" class="link">Console</a> and <a
119121
href="tdl.Window-class.html" class="link">Window</a> classes.</em>
120122
<ul>
121123
<li> <strong class="uidlink"><a href="tdl.Console-class.html">tdl.Console</a></strong>:
122-
<em class="summary">The Console is the main class of the tdl library.</em>
124+
<em class="summary">Contains character and color data and can be drawn to.</em>
123125
</li>
124126
<li> <strong class="uidlink"><a href="tdl.Window-class.html">tdl.Window</a></strong>:
125127
<em class="summary">A Window contains a small isolated part of a Console.</em>
@@ -161,7 +163,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
161163
<tr>
162164
<td align="left" class="footer">
163165
<a href="epydoc-log.html">Generated by Epydoc
164-
3.0.1 on Tue Dec 04 19:10:25 2012</a>
166+
3.0.1 on Wed Dec 05 20:07:32 2012</a>
165167
</td>
166168
<td align="right" class="footer">
167169
<a target="mainFrame" href="http://epydoc.sourceforge.net"

docs/epydoc-log.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@
1010
<body bgcolor="white" text="black" link="blue" vlink="#204080"
1111
alink="#204080">
1212
<h1 class="epydoc">Epydoc Log</h1>
13-
<p class="log">Epydoc started at Tue Dec 04 19:10:25 2012</p><div class="log-block"><h2 class="log-hdr">In C:\Users\Kyle\Dropbox\Python\python-tdl\tdl\__init__.py:
13+
<p class="log">Epydoc started at Wed Dec 05 20:07:31 2012</p><div class="log-block"><h2 class="log-hdr">In C:\Users\Kyle\Dropbox\Python\python-tdl\tdl\__init__.py:
1414
Source code parsing failed (but introspection was successful).</h2><div class="log-error"><b>Error</b>:
15-
Error during parsing: invalid syntax (C:\Users\Kyle\Dropbox\Python\python-tdl\tdl\__init__.py, line 34) -- Attempted relative import in non-package, or beyond toplevel package</div>
15+
Error during parsing: invalid syntax (C:\Users\Kyle\Dropbox\Python\python-tdl\tdl\__init__.py, line 46) -- Attempted relative import in non-package, or beyond toplevel package</div>
1616
</div><div class="log-block"><h2 class="log-hdr">In C:\Users\Kyle\Dropbox\Python\python-tdl\tdl\__tcod.py:
1717
No documentation available!</h2></div><div class="log-block"><h2 class="log-hdr">Epydoc Options</h2><div class="log-info">
1818
<table border="0" cellpadding="0" cellspacing="0">
1919
<tr valign="top" class="opt-changed"><td valign="top">configfiles</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>['epydoc.config']</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">include_log</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>True</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">inheritance</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>'included'</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">names</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>['../tdl']</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">prj_name</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>'python-tdl'</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">prj_url</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>'http://code.google.com/p/python-tdl/'</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">show_private</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">simple_term</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>True</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">target</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>'./'</tt></td></tr><tr valign="top" class="opt-changed"><td valign="top">verbosity</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>5</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">action</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>'html'</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">css</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">debug</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">docformat</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>'epytext'</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">dotpath</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">exclude</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>['__tcod']</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">exclude_introspect</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>[]</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">exclude_parse</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>[]</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">external_api</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>[]</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">external_api_file</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>[]</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">external_api_root</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>[]</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">fail_on</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">graph_font</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">graph_font_size</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">graphs</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>[]</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">help_file</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">include_source_code</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>True</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">introspect</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>True</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">list_classes_separately</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">load_pickle</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">parse</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>True</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">prj_link</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">profile</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">pstat_files</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>[]</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">quiet</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>0</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">redundant_details</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">show_frames</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>True</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">show_imports</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>False</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">src_code_tab_width</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>8</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">top_page</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>None</tt></td></tr><tr valign="top" class="opt-default"><td valign="top">verbose</td><td valign="top"><tt>&nbsp;=&nbsp;</tt></td><td valign="top"><tt>0</tt></td></tr></table>
2020
</div>
21-
</div><p class="log">Epydoc finished at Tue Dec 04 19:10:27 2012</p>
21+
</div><p class="log">Epydoc finished at Wed Dec 05 20:07:33 2012</p>
2222
<p class="log">(Elapsed time: 2 seconds)</p></body>
2323
</html>

docs/help.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ <h2> The Navigation Bar </h2>
255255
<tr>
256256
<td align="left" class="footer">
257257
<a href="epydoc-log.html">Generated by Epydoc
258-
3.0.1 on Tue Dec 04 19:10:25 2012</a>
258+
3.0.1 on Wed Dec 05 20:07:32 2012</a>
259259
</td>
260260
<td align="right" class="footer">
261261
<a target="mainFrame" href="http://epydoc.sourceforge.net"

0 commit comments

Comments
 (0)