@@ -44,21 +44,21 @@ Identifiers are integers in the range 0 to 5 inclusive.
44
44
Registering and using tools
45
45
'''''''''''''''''''''''''''
46
46
47
- .. function :: use_tool_id(id : int, name: str) -> None
47
+ .. function :: use_tool_id(tool_id : int, name: str) -> None
48
48
49
- Must be called before *id * can be used.
50
- *id * must be in the range 0 to 5 inclusive.
51
- Raises a :exc: `ValueError ` if *id * is in use.
49
+ Must be called before *tool_id * can be used.
50
+ *tool_id * must be in the range 0 to 5 inclusive.
51
+ Raises a :exc: `ValueError ` if *tool_id * is in use.
52
52
53
- .. function :: free_tool_id(id : int) -> None
53
+ .. function :: free_tool_id(tool_id : int) -> None
54
54
55
- Should be called once a tool no longer requires *id *.
55
+ Should be called once a tool no longer requires *tool_id *.
56
56
57
- .. function :: get_tool(id : int) -> str | None
57
+ .. function :: get_tool(tool_id : int) -> str | None
58
58
59
- Returns the name of the tool if *id * is in use,
59
+ Returns the name of the tool if *tool_id * is in use,
60
60
otherwise it returns ``None ``.
61
- *id * must be in the range 0 to 5 inclusive.
61
+ *tool_id * must be in the range 0 to 5 inclusive.
62
62
63
63
All IDs are treated the same by the VM with regard to events, but the
64
64
following IDs are pre-defined to make co-operation of tools easier::
0 commit comments