Merge pull request #24 from ericholscher/jinhwa/raise_up_example

raise up example
docascode · May 26, 2017 · 9708559 · 9708559
2 parents 7dd876a + 07c30cf
commit 9708559
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/docfx_yaml/extension.py b/docfx_yaml/extension.py
@@ -354,10 +354,15 @@ def find_node_in_toc_tree(toc_yaml, to_add_node):
                     # Raise up summary
                     if 'summary' in obj['syntax'] and obj['syntax']['summary']:
                         obj['summary'] = obj['syntax'].pop('summary')
+
                     # Raise up seealso
                     if 'seealso' in obj['syntax'] and obj['syntax']['seealso']:
                         obj['seealsoContent'] = obj['syntax'].pop('seealso')
 
+                    # Raise up example
+                    if 'example' in obj['syntax'] and obj['syntax']['example']:
+                        obj['example'] = obj['syntax'].pop('example')
+
                 if 'references' in obj:
                     references.extend(obj.pop('references'))
 

diff --git a/tests/test_yaml.py b/tests/test_yaml.py
@@ -215,11 +215,11 @@ def test_examples(self):
                 for item in data['items']:
                     if item['uid'] == 'example.nap.Base.ref':
                         self.assertEqual(
-                            item['syntax']['example'].split('\n')[2],
+                            item['example'].split('\n')[2],
                             """>>> print('docblock 1')"""
                         )
                         self.assertEqual(
-                            item['syntax']['example'].split('\n')[7],
+                            item['example'].split('\n')[7],
                             """>>> print('docblock 2')"""
                         )