storage:util:mapfile: fix YAML -> JSON in docstrings.
authorW. Trevor King <wking@tremily.us>
Thu, 25 Oct 2012 12:03:30 +0000 (08:03 -0400)
committerW. Trevor King <wking@tremily.us>
Thu, 25 Oct 2012 12:03:30 +0000 (08:03 -0400)
This should have been done back in:

  commit a95915c6c7d6a4e29c1e5547580e0c1fed2467e1
  Author: W. Trevor King <wking@tremily.us>
  Date:   Mon Sep 17 08:14:21 2012 -0400

    storage:util:mapfile: convert YAML settings to JSON.

I also add an empty-settings generation as a sanity check.

libbe/storage/util/mapfile.py

index d17f0d33ee43c1f64a0ecba37355213092d98546..71e5b0deef9b103166822857a26d3f237afea97e 100644 (file)
@@ -40,12 +40,14 @@ class InvalidMapfileContents (Exception):
 
 
 def generate(map):
-    """Generate a YAML mapfile content string.
+    """Generate a JSON mapfile content string.
 
     Examples
     --------
 
     >>> import sys
+    >>> sys.stdout.write(generate({}))
+    {}
     >>> sys.stdout.write(generate({'q':'p'}))
     {
     <BLANKLINE>
@@ -100,7 +102,7 @@ def generate(map):
     return '\n\n\n\n\n\n\n'.join(lines) + '\n'
 
 def parse(contents):
-    """Parse a YAML mapfile string.
+    """Parse a JSON mapfile string.
 
     Examples
     --------