Skip to content

Commit c34d037

Browse files
committed
Update docstrings.
1 parent 9b22d77 commit c34d037

File tree

4 files changed

+11
-17
lines changed

4 files changed

+11
-17
lines changed

tcod/__init__.py

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
1-
"""
2-
This module provides a simple CFFI API to libtcod.
3-
4-
This port has large partial support for libtcod's C functions.
5-
Use tcod/libtcod_cdef.h in the source distribution to see specially what
6-
functions were exported and what new functions have been added by TDL.
7-
8-
The ffi and lib variables should be familiar to anyone that has used CFFI
9-
before, otherwise it's time to read up on how they work:
10-
https://cffi.readthedocs.org/en/latest/using.html
1+
"""The fast Python port of libtcod.
112
12-
Otherwise this module can be used as a drop in replacement for the official
13-
libtcod.py module.
3+
This module can be used as a drop in replacement for the official libtcodpy
4+
module.
145
15-
Bring any issues or requests to GitHub:
16-
https://github.com/HexDecimal/libtcod-cffi
6+
Bring any issues or feature requests to GitHub:
7+
https://github.com/libtcod/python-tcod
178
"""
189
import sys
1910
import warnings

tcod/console.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1063,6 +1063,9 @@ def draw_frame(
10631063
10641064
`title` is a Unicode string. The title is drawn with `bg` as the text
10651065
color and `fg` as the background.
1066+
Using the `title` parameter is discouraged since the style it uses is
1067+
hard-coded into libtcod. You should print over the top or bottom
1068+
border with :any:`Console.print_box` using your own style.
10661069
10671070
If `clear` is True than the region inside of the frame will be cleared.
10681071

tcod/constants.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
"""
2-
Constants from the libtcod C API.
1+
"""Constants from the libtcod C API.
32
43
This module is auto-generated by `build_libtcod.py`.
54
"""

tcod/random.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
"""
1+
"""Ports of the libtcod random number generator.
2+
23
Usually it's recommend to the Python's standard library `random` module
34
instead of this one.
45

0 commit comments

Comments
 (0)