Param Docs

This page contains auto-generated docs for the GUI.

Controllers

class param_docs.controller.FruitStallController(**params)

Fruit Stall

This controller lets the user choose a type of fruit, set the amount and then buy some. The docstring has two lines. Which is ignored. Lets try some whitespace.

This is the next line after the whitespace.

Fruit (Selector, default=’apple’, options=[‘apple’, ‘pear’, ‘banana’])

Select type of fruit to buy.

Quantity (Integer, bounds=(0, None), default=5)

Number of selected fruit to buy.

Price (Number, bounds=(0, None), default=0.0)

Price of the fruit per piece.

Make Purchase (Action)

Press this button to buy some fruit!

class param_docs.controller.SuperMarketController(**params)

Supermarket

This controller extends the Fruit Stall into a Supermarket, also offering users a selection of milk and cheeses.

Milk (Selector, default=’semi-skimmed’, options=[‘full-fat’, ‘semi-skimmed’, ‘skimmed’])

Select fat content for the milk.

Cheese (Selector, default=’Jong Belegen’, options=[‘Jong Belegen’, ‘Brie’, ‘Reblouchon’])

Jong Belegen is highly recommended.

Additional GUI elements on:

param_docs.controller.FruitStallController: hidden_param, fruit, quantity, price, button

class param_docs.controller.NormalClass(arg1, arg2)

This is a normal numpydoc style docstring

Parameters

arg1float

Argument 1

arg2float

Argument 2

Attributes

argfloat

Argument

Methods

do_something()

This function does a thing.

do_something()

This function does a thing.

Returns

ansfloat

Returns the double of the arg attribute.