Skip to content

Commit ececc9b

Browse files
HexDecimalHexDecimal
committed
updated docs, shortened fgcolor and bgcolor
The parameter names fgcolor and bgcolor have been shortened to fg and bg. Documentation has been updated.
1 parent 56fc525 commit ececc9b

39 files changed

+3607
-2824
lines changed

‎README.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Online Documentation: http://pythonhosted.org/tdl/
2828

2929
Issue Tracker: https://github.com/HexDecimal/python-tdl/issues
3030

31-
python-tdl is a ctypes port of "libtcod". You can find more about libtcod at http://doryen.eptalys.net/libtcod/
31+
python-tdl is a ctypes port of "libtcod". You can find more about libtcod at http://roguecentral.org/doryen/libtcod/
3232

3333
==============
3434
Requirements

‎dev/runRegressionTest.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ def setUp(self):
3737

3838
@classmethod
3939
def tearDownClass(cls):
40+
time.sleep(2)
4041
del cls.console
4142
gc.collect() # make sure console.__del__ is called quickly
4243

@@ -270,11 +271,12 @@ def test_scrolling(self):
270271
several areas and not clearing the console every loop.
271272
"""
272273
scrollTests = set([(0, 0), (WIDTH, HEIGHT)]) # include zero and out of bounds
273-
while len(scrollTests) < 5: # add 3 more randoms
274+
while len(scrollTests) < 10: # add 3 more randoms
274275
scrollTests.add((random.randint(-WIDTH, WIDTH),
275276
random.randint(-HEIGHT, HEIGHT)))
276277
for sx, sy in scrollTests:
277278
noiseData = dict(self.randomizeConsole())
279+
self.console.set_colors((0, 0, 0), (0, 0, 0))
278280
self.console.scroll(sx, sy)
279281
self.flush() # show progress
280282
for x, y in self.getDrawables():

‎dev/stressTest.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ def __init__(self, console):
5151
self.width, self.height = self.console.getSize()
5252
self.total = self.width * self.height
5353
self.cells = list(itertools.product(range(self.width), range(self.height)))
54+
self.tick = 0
5455
self.init()
5556

5657
def init(self):
@@ -61,6 +62,8 @@ def ev_MOUSEDOWN(self, event):
6162

6263
def update(self, deltaTime):
6364
self.updateTest(deltaTime)
65+
self.tick += 1
66+
#if self.tick % 50 == 0:
6467
tdl.setTitle('%s: %i FPS' % (self.__class__.__name__, tdl.getFPS()))
6568
tdl.flush()
6669

@@ -152,7 +155,7 @@ def updateTest(self, deltaTime):
152155
WIDTH = 46
153156
HEIGHT = 20
154157
def main():
155-
console = tdl.init(46, 20)
158+
console = tdl.init(46, 20, renderer='OPENGL')
156159
for Test in [FullDrawCharTest, PreCompiledColorTest, CharOnlyTest, TypewriterCharOnlyTest, ColorOnlyTest, GetCharTest,
157160
SingleRectTest, DrawStrTest, BlitScrollTest]:
158161
Test(console).run()

‎docs/api-objects.txt‎

Lines changed: 88 additions & 118 deletions
Large diffs are not rendered by default.

‎docs/class-tree.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
114114
<li> <strong class="uidlink"><a href="tdl.noise.Noise-class.html">tdl.noise.Noise</a></strong>:
115115
<em class="summary">An advanced noise generator.</em>
116116
</li>
117-
<li> <strong class="uidlink"><a href="tdl._MetaConsole-class.html">tdl._MetaConsole</a></strong>:
117+
<li> <strong class="uidlink"><a href="tdl._BaseConsole-class.html">tdl._BaseConsole</a></strong>:
118118
<em class="summary">Contains methods shared by both the <a
119119
href="tdl.Console-class.html" class="link">Console</a> and <a
120120
href="tdl.Window-class.html" class="link">Window</a> classes.</em>
@@ -162,7 +162,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
162162
<tr>
163163
<td align="left" class="footer">
164164
<a href="epydoc-log.html">Generated by Epydoc
165-
3.0.1 on Fri Apr 03 23:20:01 2015</a>
165+
3.0.1 on Sat Jun 06 23:13:11 2015</a>
166166
</td>
167167
<td align="right" class="footer">
168168
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎docs/epydoc-log.html‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,30 @@
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 Fri Apr 03 23:19:59 2015</p><div class="log-block"><h2 class="log-hdr">In C:\Users\Kyle\Documents\GitHub\python-tdl\tdl\__init__.py:
13+
<p class="log">Epydoc started at Sat Jun 06 23:13:09 2015</p><div class="log-block"><h2 class="log-hdr">In C:\Users\Kyle\Documents\GitHub\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\Documents\GitHub\python-tdl\tdl\__init__.py, line 62) -- Attempted relative import in non-package, or beyond toplevel package</div>
15+
Error during parsing: invalid syntax (C:\Users\Kyle\Documents\GitHub\python-tdl\tdl\__init__.py, line 71) -- 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\Documents\GitHub\python-tdl\tdl\__style.py:
1717
No documentation available!</h2></div><div class="log-block"><h2 class="log-hdr">In C:\Users\Kyle\Documents\GitHub\python-tdl\tdl\__tcod.py:
18-
No documentation available!</h2></div><div class="log-warning"><b>Docstring Warning</b>:
18+
No documentation available!</h2></div><div class="log-warning"><b>Warning</b>:
19+
@group Drawing Methods: tdl._BaseConsole.clear not found</div>
20+
<div class="log-warning"><b>Docstring Warning</b>:
1921
<pre class="log">Failed identifier crossreference targets:
2022
- Typewriter
21-
(from tdl._MetaConsole.draw_str)
22-
(from tdl._MetaConsole.write)
23+
(from tdl._BaseConsole.write)
2324
- addChar
24-
(from tdl._MetaConsole.get_cursor)
25+
(from tdl._BaseConsole.get_cursor)
2526
- addStr
26-
(from tdl._MetaConsole.get_cursor)
27+
(from tdl._BaseConsole.get_cursor)
28+
- clear
29+
(from tdl._BaseConsole.draw_rect)
30+
- set_colors
31+
(from tdl)
2732
</pre></div>
2833
<div class="log-block"><h2 class="log-hdr">Epydoc Options</h2><div class="log-info">
2934
<table border="0" cellpadding="0" cellspacing="0">
3035
<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>['__\\w+']</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>
3136
</div>
32-
</div><p class="log">Epydoc finished at Fri Apr 03 23:20:03 2015</p>
37+
</div><p class="log">Epydoc finished at Sat Jun 06 23:13:12 2015</p>
3338
<p class="log">(Elapsed time: 3 seconds)</p></body>
3439
</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 Fri Apr 03 23:20:01 2015</a>
258+
3.0.1 on Sat Jun 06 23:13:11 2015</a>
259259
</td>
260260
<td align="right" class="footer">
261261
<a target="mainFrame" href="http://epydoc.sourceforge.net"

0 commit comments

Comments
 (0)