`Callable`s in `ros_alarms` documentation should be typed with input parameters and result

[cbrxyz]

Assignee

No response

Deadline

No response

What needs to change?

Many classes in the ros_alarms documentation (available here) use the Callable type to indicate that a function should be supplied or returned by a given function or property value. However, these typing classes can (and should) also be documented with their expected input parameters and return type.

This can be done as so:

a: Callable[[int, int], bool] # Function that takes two integers and returns a bool
b: Callable[[], str] # Callable that takes no parameters and returns a string
c: Callable[[...], None] # Callable that takes in an undefined set of parameters and returns nothing (or None)

How would this task be tested?

1. Fix the typings in the code and docstrings of the relevant classes/methods in ros_alarms. Build the docs, and observe that the typings are correct and present in the output documentation.

Contacts

• [ ] We need help from the mechanical team.
• [ ] We need help from the electrical team.
• [ ] We need help from Dr. Schwartz or other faculty.
• [ ] We need help from a company or an organization.
• [ ] We need help from another UF staff member or organization (ex, facilities).