This is test documentation

Small module to provide sourcecode for testing if everything works as needed

autodoc_napoleon_typehints_example.format_unit(self, value, unit, test)
Return type:str

Formats the given value as a human readable string using the given units.

Parameters:
  • value (Union[float, int]) – a numeric value
  • unit (str) – the unit for the value (kg, m, etc.)
  • test (Optional[(typing.Iterable[+T_co],)]) – bla bla blathe unit for the value (kg, m, etc.)
autodoc_napoleon_typehints_example.format_unit_google(self, value, unit, test)
Return type:str

Formats the given value as a human readable string using the given units.

Parameters:
  • value (Union[float, int]) – a numeric value
  • unit (str) – the unit for the value (kg, m, etc.)
  • test (Optional[(typing.Iterable[+T_co],)]) – bla bla blathe unit for the value (kg, m, etc.)
Returns:

This function returns something of value: and does not overwrite this part.

autodoc_napoleon_typehints_example.format_unit_numpy(self, value, unit, test)
Return type:str

Formats the given value as a human readable string using the given units.

Parameters:
  • value (a numeric value) –
  • unit (the unit for the value (kg, m, etc.)) –
  • test (bla bla blathe unit for the value (kg, m, etc.)) –
Returns:

  • This function returns something of
  • value (and does not overwrite this part.)