mypkg

Example API docs

Mojo package 🡭

mypkg

Package mypkg provides an example for Modo🧯 API docs.

The package has some re-exported dummy members (optional) as well as a subpkg. The docstring for the package looks like this:

"""
Package `example` provides an example for Modo🧯 API docs.

The package has some re-exported dummy members (optional) as well as a [.subpkg].
The source code of the package looks like this:

<code block excluded>

Exports:
 - mymodule.MyPair
 - mymodule.MyIntAlias
 - subpkg
"""
from .mymodule import MyPair, MyIntAlias

Aliases

  • MyIntAlias = Int: An example module alias.

Structs

  • MyPair: A simple example struct.

Packages