Fix optional DictationContainer *spoken_form* method parameter

Re: dictation-toolbox#387.

This parameter is now on the base class `format()' method and has
the correct name.

Author: drmfinlay

dragonfly/engines/backend_natlink/dictation.py

@@ -56,16 +56,7 @@ def __init__(self, words, methods):
         DictationContainerBase.__init__(self, words=unicode_words,
                                         methods=methods)
 
-    def format(self, use_spoken=False):
-        """
-        Format and return this dictation.
-
-        Arguments:
-         - *use_spoken* (*bool*, default: *False*) --
-           whether to use the spoken form of dictated words in the result
-           instead of the written form
-
-        """
+    def format(self, spoken_form=False):
         formatter = WordFormatter()
-        formatted = formatter.format_dictation(self._words, use_spoken)
+        formatted = formatter.format_dictation(self._words, spoken_form)
         return self.apply_methods(formatted)

dragonfly/engines/base/dictation.py

@@ -236,8 +236,17 @@ def words(self):
         """ Sequence of the words forming this dictation. """
         return self._words
 
-    def format(self):
-        """ Format and return this dictation as a Unicode object. """
+    def format(self, spoken_form=False):
+        """
+        Format and return this dictation as a string.
+
+        Arguments:
+         - *spoken_form* (*bool*, default: *False*) --
+           whether to use the spoken form of dictated words in the result
+           instead of the written form.  Only has an effect if using the
+           Natlink/DNS engine back-end
+
+        """
         return self.apply_methods(u" ".join(self._words))
 
     def apply_methods(self, joined_words):