mobgap.cadence.base.base_cad_docfiller#

mobgap.cadence.base.base_cad_docfiller(func: Callable) str[source]#

Decorator to fill common parts of the docstring for subclasses of BaseCadenceCalculator.

Available keys for the substitution:

['other_parameters', 'cadence_per_sec_', 'calculate_short', 'calculate_para', 'calculate_return']