Failed Conditions
Pull Request — master (#1139)
by Mischa
01:50
created

__str__()   A

Complexity

Conditions 1

Size

Total Lines 2

Duplication

Lines 0
Ratio 0 %
Metric Value
cc 1
dl 0
loc 2
rs 10
1
from coalib.misc.Decorators import generate_eq, generate_repr
2
3
4
@generate_repr()
5
@generate_eq("documentation", "marker", "range")
6
class DocumentationComment:
7
    """
8
    The DocumentationComment holds information about a documentation comment
9
    inside source-code, like position etc.
10
    """
11
12
    def __init__(self, documentation, marker, range):
13
        """
14
        Instantiates a new DocumentationComment.
15
16
        :param documentation: The documentation text.
17
        :param marker:        The three-element tuple with marker strings that
18
                              identified this documentation comment.
19
        :param range:         The position range of type TextRange.
20
        """
21
        self.documentation = documentation
22
        self.marker = marker
23
        self.range = range
24
25
    def __str__(self):
26
        return self.documentation
27