Skip to content

Commit f7a58b4

Browse files
committed
Fix docstrings / scopes for python ThreeWidget
1 parent f2bb301 commit f7a58b4

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

pythreejs/_base/Three.py

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,35 @@
66

77

88
class ThreeWidget(Widget):
9+
"""Base widget type for all pythreejs widgets"""
10+
911
_model_module = Unicode(npm_pkg_name).tag(sync=True)
1012
_model_module_version = Unicode(EXTENSION_VERSION).tag(sync=True)
1113

1214
def __init__(self, **kwargs):
1315
super(ThreeWidget, self).__init__(**kwargs)
14-
self.on_msg(self.on_potential_ret_val)
16+
self.on_msg(self._on_potential_ret_val)
1517

1618
def exec_three_obj_method(self, method_name, *args, **kwargs):
19+
"""Execute a method on the three object.
20+
21+
Excute the method specified by `method_name` on the three
22+
object, with arguments `args`. `kwargs` is currently ignored.
23+
"""
1724
content = {
1825
"type": "exec_three_obj_method",
1926
"method_name": method_name,
2027
"args": widget_serialization['to_json'](args, None)
2128
}
2229
self.send(content=content, buffers=None)
2330

24-
def on_potential_ret_val(self, widget, content, buffers):
31+
def _on_potential_ret_val(self, widget, content, buffers):
32+
"""Message callback used internally"""
2533
if content['type'] == "exec_three_obj_method_retval":
26-
self.on_ret_val(content['method_name'], content['ret_val'])
34+
self._on_ret_val(content['method_name'], content['ret_val'])
2735

28-
def on_ret_val(self, method_name, ret_val):
36+
def _on_ret_val(self, method_name, ret_val):
37+
"""Message callback used internally for logging exec returns"""
2938
self.log.info('%s() -> %s' % (method_name, ret_val))
3039

3140
def _ipython_display_(self, **kwargs):

0 commit comments

Comments
 (0)