module subproject.myexampleb

Inheritance diagram of python3_module_template.subproject.myexampleb

Short summary

module python3_module_template.subproject.myexampleb

This the documentation of this module (myexampleb).

source on GitHub

Classes

class

truncated documentation

myclassb

This is the documentation for this class. Inherits from myclass. An example on how to share: . …

Functions

function

truncated documentation

onefunction

Returns the addition of a+b.

Methods

method

truncated documentation

__init__

method_napoleon

Example of a docstring used by sphinx.ext.napoleon extension. Args: v1 (int): a integer …

Documentation

This the documentation of this module (myexampleb).

source on GitHub

class python3_module_template.subproject.myexampleb.myclassb(pa)[source]

Bases: python3_module_template.subproject.myexample.myclass

This is the documentation for this class. Inherits from myclass. An example on how to share: .

Todo(enhancement): An example of a todo

Check the documentation to see how it is rendered.

issue

source on GitHub

Parameters

pa – first parameter

source on GitHub

__init__(pa)[source]
Parameters

pa – first parameter

source on GitHub

method_napoleon(v1, v2)[source]

Example of a docstring used by sphinx.ext.napoleon extension.

Parameters
  • v1 (int) – a integer

  • v2 (float) – a float

Returns

the sum

Return type

float

Raises

TypeError – for a type mismatch

See google style

source on GitHub

python3_module_template.subproject.myexampleb.onefunction(a, b)[source]

Returns the addition of a+b.

Parameters
  • a – first element

  • b – second element

Returns

a + b

Raises

TypeError – if a and b have different types.

source on GitHub