Generated Code Documentation

pypi_template.module

A very stupid example module, mainly for showing documentation generation.

Module Contents

Classes

Template

A very stupid example class, mainly for showing documentation generation.

API

class pypi_template.module.Template

A very stupid example class, mainly for showing documentation generation.

Initialization

Initializes a flag to track wether the other party said hello first.

hello()

Tracks that the other party said hello.

my_name_is(name='Christophe')

This function says hello. Accepts an optional name and formats a salutation given that name. Args: name: A optional string as name of some nice person to say hello to. Returns: A personalized salutation in the form of a string.