Module advtrains_doc_integration.describe
Describing things.
This module includes functions used for describing things.
Functions
| conns (conns) | Describe a conns object |
| mixed_fraction (int, num, denom) | Describe a (mixed) fraction |
| length (x) | Describe a short length (using mm and in). |
| speed (x) | Describe a speed value (using m/s, km/h and mph). |
Functions
- conns (conns)
-
Describe a conns object
Parameters:
- conns advtrains.conns or {advtrains.conns,number,...} The conns object to describe.
Returns:
-
string or nil
The description of the conns object.
- mixed_fraction (int, num, denom)
-
Describe a (mixed) fraction
Parameters:
- int integer The integer part of the number.
- num integer The numerator.
- denom integer The denominator.
Returns:
-
string
The description of the mixed fraction.
- length (x)
-
Describe a short length (using mm and in).
Parameters:
- x number The length in meters.
Returns:
-
string
The description of the length.
- speed (x)
-
Describe a speed value (using m/s, km/h and mph).
Parameters:
- x number The speed in m/s.
Returns:
-
string
The description of the speed.