Skip to content
Snippets Groups Projects
Commit 7a1f6290 authored by Corné Lukken's avatar Corné Lukken
Browse files

Documentation example

parent d53e08b9
No related branches found
No related tags found
1 merge request!4Documentation example
Pipeline #59693 passed with warnings
Pipeline: Python Binary Wheel Package

#59694

    """ Cool module containing functions, classes and other useful things """ """ Cool module containing functions, classes and other useful things """
    from typing import Union
    from collections import OrderedDict
    def greeter(): def greeter():
    """Prints a nice message""" """Prints a nice message"""
    print("Hello World!, test line over 80 but not 88 characters on a single line") print("Hello World!, test line over 80 but not 88 characters on a single line")
    class DocumentationExample:
    """Class to demonstrate docstring documentation"""
    def __init__(self):
    self.attribute: str = "Hello World"
    def operate(self, data: Union[str, int]) -> int:
    """Perform operation
    :py:attr:`.self.attribute`
    :py:func:`~.greeter`
    :py:class:`collections.OrderedDict`
    ``OrderedDict(data)``
    :param data: The data to peform the operation on
    :raises RuntimeError: Raised if not enough memory to create Dict
    :return: integer value representing success or failure
    """
    test = OrderedDict()
    return 0
    0% Loading or .
    You are about to add 0 people to the discussion. Proceed with caution.
    Please register or to comment