MyClass

Here I will have the documentation about my class.

MyClass

summary

Attributes:
  • attr (int) –

    description
Source code in src/my_lib/my_class.py 
class MyClass:
    """_summary_

    Attributes:
        attr (int): description
    """
    def __init__(self, attr1: int):
        """_summary_

        Args:
            attr1 (int): _description_
        """
        self.attr1 = attr1

    def method1(self, message: str) -> str:
        """print 'message attr1'

        Args:
            message (str): _description_

        Outputs:
            message (str): _description_
        """
        return f"{message} {self.attr1}"

__init__(attr1)

summary

Parameters:
  • attr1 (int) –

    description
Source code in src/my_lib/my_class.py 
def __init__(self, attr1: int):
    """_summary_

    Args:
        attr1 (int): _description_
    """
    self.attr1 = attr1

method1(message)

print 'message attr1'

Parameters:
  • message (str) –

    description
Outputs

message (str): description

Source code in src/my_lib/my_class.py 
def method1(self, message: str) -> str:
    """print 'message attr1'

    Args:
        message (str): _description_

    Outputs:
        message (str): _description_
    """
    return f"{message} {self.attr1}"