Add comment linking to ipython doc

gnwong · Mar 29, 2021 · 5693bb0 · 5693bb0
1 parent 6a1cb47
commit 5693bb0
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/yt/config.py b/yt/config.py
@@ -195,6 +195,8 @@ def __getitem__(self, key):
     def __contains__(self, item):
         return item in self.config_root
 
+    # Add support for IPython rich display
+    # see https://ipython.readthedocs.io/en/stable/config/integrating.html
     def _repr_json_(self):
         return self.config_root._repr_json_()
 

diff --git a/yt/utilities/configuration_tree.py b/yt/utilities/configuration_tree.py
@@ -137,12 +137,14 @@ def as_dict(self, callback=lambda child: child.value):
     def __repr__(self):
         return f"<Node {self.key}>"
 
-    def _repr_json_(self):
-        return self.as_dict()
-
     def __contains__(self, item):
         return item in self.children
 
+    # Add support for IPython rich display
+    # see https://ipython.readthedocs.io/en/stable/config/integrating.html
+    def _repr_json_(self):
+        return self.as_dict()
+
 
 class ConfigLeaf:
     def __init__(self, key, parent: ConfigNode, value, extra_data=None):