module helpgen._fake_function_to_documentation

Short summary

module pyquickhelper.helpgen._fake_function_to_documentation

This file is to compare different documentation style.

source on GitHub

Functions

function

truncated documentation

f1

Addition 1

f2

Addition 2

f3

Addition 3

f4

Addition 4

f5

Addition 5 Parameters ———- a: parameter a b: parameter b Returns ——- a+b

f6

Addition 6 Args: a: parameter a b: parameter b Returns: a+b

Documentation

This file is to compare different documentation style.

source on GitHub

pyquickhelper.helpgen._fake_function_to_documentation.f1(a, b)[source][source]

Addition 1

Parameters

  • a – parameter a

  • b – parameter b

Returns

a+b

source on GitHub

pyquickhelper.helpgen._fake_function_to_documentation.f2(a, b)[source][source]

Addition 2

Parameters

  • a – parameter a

  • b – parameter b

Returns

a+b

source on GitHub

pyquickhelper.helpgen._fake_function_to_documentation.f3(a, b)[source][source]

Addition 3

Parameters

  • a – parameter a

  • b – parameter a

Returns

a+b

source on GitHub

pyquickhelper.helpgen._fake_function_to_documentation.f4(a, b)[source][source]

Addition 4

param a

parameter a

param b

parameter a

returns

a+b

source on GitHub

pyquickhelper.helpgen._fake_function_to_documentation.f5(a, b)[source][source]

Addition 5

Parameters

  • a (parameter a) –

  • b (parameter b) –

Returns

Return type

a+b

source on GitHub

pyquickhelper.helpgen._fake_function_to_documentation.f6(a, b)[source][source]

Addition 6

Parameters

  • a – parameter a

  • b – parameter b

Returns

a+b

source on GitHub