Source code for my_toy_package.SubPackage2.MyClass2

# -*- coding: utf-8 -*-
"""
Copyright François Durand
fradurand@gmail.com

This file is part of My Toy Package.

    My Toy Package is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    My Toy Package is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with My Toy Package.  If not, see <http://www.gnu.org/licenses/>.
"""


[docs]class MyClass2: """A whatever-you-are-doing. Parameters ---------- a : float The `a` of the system. b : float The `b` of the system. Examples -------- >>> my_object = MyClass2(a = 5, b = 3) """ def __init__(self, a: float, b: float): self.a = a self.b = b
[docs] def addition(self) -> float: """Add `a` and `b`. Returns ------- Float The sum of `a` and `b`. Examples -------- >>> my_object = MyClass2(a=5, b=3) >>> my_object.addition() 8 """ return self.a + self.b