Skip to content

Commit 0f52b51

Browse files
committed
Updated documentation
1 parent bd70870 commit 0f52b51

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

graphics/graphics_canvas.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,9 @@ def __handle_keyboard_inputs(self):
336336
def __reload_caption(self, new_list):
337337
"""
338338
Reload the UI with the new list of robot names
339+
340+
:param new_list: The new list to apply to the menu
341+
:type new_list: `list`
339342
"""
340343
# Remove all UI elements
341344
for item in self.__ui_controls:
@@ -351,7 +354,10 @@ def __reload_caption(self, new_list):
351354

352355
def __load_mode_ui(self, new_list):
353356
"""
357+
Load the UI menu depending on the current mode
354358
359+
:param new_list: The new list to apply to the menu
360+
:type new_list: `list`
355361
"""
356362
if self.__ui_mode == UImode.CANVASCONTROL:
357363
self.__ui_controls = self.__setup_ui_controls(new_list)

graphics/graphics_text.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@
44

55
def get_text_size(scene):
66
"""
7+
Determine the text size based on zoom distance
78
9+
:param scene: The scene in which the camera to be used resides.
10+
:type scene: `vpython.canvas`
811
"""
912
# Distance of camera from focus point to determine text size
1013
distance_from_center = mag(scene.center - scene.camera.pos)

0 commit comments

Comments
 (0)