API Reference¶

class Environments.HelloEnvironment¶

Summary line: The proof of concept

Extended description: The proof of concept

world()¶

Summary line: This function spits out a Hello World back and ensures that the build system works.

Extended description: This function spits out a Hello World back and ensures that the build system works.

Parameters:	arg1 (int) – Description of arg1. Description of arg1. Description of arg1. Description of arg1. Description of arg1. Description of arg1.
Returns:	Description of return value. Description of return value. Description of return value. Description of return value.
Return type:	bool

Examples should be written in doctest format, and should illustrate how to use the function.

>>> from omg.Environments import HelloEnvironment
>>> hello = HelloEnvironment()
>>> print(hello.world())
Hello World, back!