Minor doc fixes

Author: mdboom

Diff for: doc/source/conf.py

@@ -18,7 +18,7 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('..'))
 
 # -- General configuration -----------------------------------------------------
 

Diff for: doc/source/intro.rst

@@ -35,10 +35,10 @@ The bitmap data can be converted to a list::
     [[0L, 0L, 0L, 0L, 0L, 0L, 10L, 85L, 142L, 195L, 222L, 238L, 252L,
      243L, 230L, 207L, 170L, 132L, 76L, 17L, 0L, 0L, 0L, 0L, 0L, 0L] ...
 
-However, two display it at the console, it's usually nicer to use the
-`freetypy.util.draw_glyph_to_console` helper function::
+However, to display it at the console, it's usually nicer to use the
+`freetypy.util.bitmap_to_ascii` helper function::
 
-    >>> ft.util.draw_glyph_to_console(bitmap.to_list())
+    >>> ft.util.bitmap_to_ascii(bitmap)
            .+*******++.
          +*############**.
        .*##################
@@ -78,7 +78,7 @@ However, two display it at the console, it's usually nicer to use the
          .++*******+.
 
 This `~freetypy.Bitmap` is a Python buffer object.  If you have Numpy,
-that provides the most efficient way to access the data in the bitmap::
+you can easily convert this data to an array::
 
     >>> import numpy as np
     >>> array = np.array(bitmap)

Diff for: lib/freetypy/tests/util.py

@@ -40,7 +40,7 @@
 from nose.tools import raises
 
 
-from ..util import vera_path, draw_glyph_to_console
+from ..util import vera_path, bitmap_to_ascii
 
 
 try:
@@ -55,7 +55,7 @@ class SkipTest(Exception):
 
 
 __all__ = ['skip_if', 'vera_path', 'make_assert', 'raises',
-           'draw_glyph_to_console']
+           'bitmap_to_ascii']
 
 
 def skip_if(predicate):

Diff for: lib/freetypy/util.py

@@ -35,25 +35,31 @@
 
 
 import os
+import sys
 
 
 __all__ = ['vera_path', 'draw_glyph_to_console']
 
 
 def vera_path():
+    """
+    Returns the path to the copy of Bitstream Vera Sans that ships
+    with freetypy for testing purposes.
+    """
     return os.path.join(os.path.dirname(__file__), 'data', 'Vera.ttf')
 
 
-def draw_glyph_to_console(a):
+def glyph_to_ascii(a):
     """
-    Draws a single glyph, as either a nested list or a Numpy array, to
-    the console.
+    Converts a single glyph to a string with an ASCII drawing of that
+    glyph.
     """
     shades = ' .+*#'
 
-    for row in a:
+    lines = []
+    for row in a.to_list():
         for col in row:
             col = int(float(col) / 255. * 4.)
             c = shades[col]
-            print(c, end='')
-        print()
+            lines.append(c)
+    return '\n'.join(lines)