Renamed 'smart_substitutions' option to 'substitutions'. Fixed a typo.

waylan · Aug 15, 2014 · e7b6a33 · e7b6a33
1 parent e90687e
commit e7b6a33
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 8 deletions.
diff --git a/docs/extensions/smarty.txt b/docs/extensions/smarty.txt
@@ -22,7 +22,7 @@ ASCII symbol | Replacements    | HTML Entities
 `--`         | &ndash;         | `&ndash;`
 `---`        | &mdash;         | `&mdash;`
 
-Using the configuration option 'smart_substitutions' you can overwrite the
+Using the configuration option 'substitutions' you can overwrite the
 default substitutions. Just pass a dict mapping (a subset of) the following
 keys to the substitution strings.
 
@@ -34,7 +34,7 @@ keys to the substitution strings.
 Use e.g. the following config to get correct quotes for the German language:
 
     extensionConfigs = {
-        'smarty': [('smart_substitutions', {
+        'smarty': [('substitutions', {
                     'left-single-quote': '&sbquo;', # sb is not a typo!
                     'right-single-quote': '&lsquo;',
                     'left-double-quote': '&bdquo;',
@@ -71,7 +71,7 @@ Option                | Default value | Description
 `smart_quotes`        | enabled       | whether to convert straight quotes
 `smart_angled_quotes` | disabled      | whether to convert angled quotes
 `smart_ellipses`      | enabled       | whether to convert ellipses
-`smart_substitutions` | {}            | Overwrite default substitutions
+`substitutions`       | {}            | overwrite default substitutions
 
 Further reading
 ---------------

diff --git a/markdown/extensions/smarty.py b/markdown/extensions/smarty.py
@@ -151,12 +151,11 @@ def __init__(self, *args, **kwargs):
             'smart_angled_quotes': [False, 'Educate angled quotes'],
             'smart_dashes': [True, 'Educate dashes'],
             'smart_ellipses': [True, 'Educate ellipses'],
-            'smart_substitutions' : [{}, 'Overwrite default substitutions'],
+            'substitutions' : [{}, 'Overwrite default substitutions'],
         }
         super(SmartyExtension, self).__init__(*args, **kwargs)
         self.substitutions = dict(substitutions)
-        self.substitutions.update(self.getConfig('smart_substitutions',
-                                                 default={}))
+        self.substitutions.update(self.getConfig('substitutions', default={}))
 
     def _addPatterns(self, md, patterns, serie):
         for ind, pattern in enumerate(patterns):

diff --git a/tests/test_extensions.py b/tests/test_extensions.py
@@ -590,7 +590,7 @@ def setUp(self):
         config = {
                 'smarty': [
                     ('smart_angled_quotes', True),
-                    ('smart_substitutions', {
+                    ('substitutions', {
                         'ndash': '\u2013',
                         'mdash': '\u2014',
                         'ellipsis': '\u2026',
@@ -615,4 +615,4 @@ def testCustomSubstitutions(self):
 """<p>[ The &bdquo;Unicode char of the year 2014&ldquo;
 is the &sbquo;mdash&lsquo;: \u2014
 Must not be confused with &sbquo;ndash&lsquo;  (\u2013) \u2026 ]</p>"""
-        self.assertEqual(self.md.convert(text), correct)
+        self.assertEqual(self.md.convert(text), correct)