# lookatme.tutorial module

Functions and sources for the markdown tutorial slides!

class lookatme.tutorial.Tutor(name: str, group: str, slides_md: str, impl_fn: Callable, order: int, lazy_formatting: Callable | None = None)

  Bases: `object`

  A class to handle/process tutorials for specific functionality

  In addition to name, group, and slides content of the tutor, each Tutor must also be associated with the implementation.

  get_md(rendered_example=True) → str

    Get the tutor’s markdown text after resolving any special markup contained in it.

    > opts. Dict[str, Any]

    >   slides. Current can include `{

lookatme.tutorial.get_tutorial_help() → str

lookatme.tutorial.get_tutorial_md(groups_or_tutors: List[str]) → None | str

lookatme.tutorial.get_tutors(group_or_tutor: str) → List[Tutor]

lookatme.tutorial.pretty_close_match(str1, str2)

lookatme.tutorial.print_tutorial_help()

lookatme.tutorial.tutor(group: str, name: str, slides_md: str, order: int = 99999, lazy_formatting: Callable | None = None)

  Define tutorial slides by using this as a decorator on a function!