Home - haltosan/RA-python-tools GitHub Wiki

Welcome to the RA-python-tools wiki!

There are some docs on some of the python we've written to help with the projects we have in the lab.

Feel free to add any pages in the wiki that others could find useful. This could be your own documentation, or reference pages for easy access.

A note about type hints

For those that haven't seen these before, many of the functions documented here have type hints. These are the types that the function is expecting and returning. This is meant to increase readability when functions have ambiguous names regarding type but nonetheless decent names. Ex:

def openFile(file: str) -> str:
  # function body

This means that the function parameter file is a string (param: type) and openFile returns a string (-> returnType). If no parameter type is given, assume the name is specific enough to imply type. If no return type is given, expect no return.