Completed
Pull Request — master (#51)
by Oleg
02:58
created

CaptionNode.is_block_command()   A

Complexity

Conditions 1

Size

Total Lines 7

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 1
CRAP Score 1.125

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 7
ccs 1
cts 2
cp 0.5
rs 9.4285
cc 1
crap 1.125
1
"""
2
SDoc
3
4
Copyright 2016 Set Based IT Consultancy
5
6
Licence MIT
7
"""
8
# ----------------------------------------------------------------------------------------------------------------------
9 1
from sdoc.sdoc2.NodeStore import NodeStore
10 1
from sdoc.sdoc2.node.Node import Node
11
12
13 1
class CaptionNode(Node):
14
    """
15
    SDoc2 node for captions.
16
    """
17
18
    # ------------------------------------------------------------------------------------------------------------------
19 1
    def __init__(self, io, options, argument):
20
        """
21
        Object constructor.
22
23
        :param None|cleo.styles.output_style.OutputStyle io: The IO object.
24
        :param dict[str,str] options: The options of this caption.
25
        :param str argument: The title of this caption.
26
        """
27
        super().__init__(io, 'caption', options, argument)
28
29
    # ------------------------------------------------------------------------------------------------------------------
30 1
    def get_command(self):
31
        """
32
        Returns the command of this node, i.e. caption.
33
34
        :rtype: str
35
        """
36
        return 'caption'
37
38
    # ------------------------------------------------------------------------------------------------------------------
39 1
    def is_block_command(self):
40
        """
41
        Returns False.
42
43
        :rtype: bool
44
        """
45
        return False
46
47
    # ------------------------------------------------------------------------------------------------------------------
48 1
    def is_inline_command(self):
49
        """
50
        Returns True.
51
52
        :rtype: bool
53
        """
54
        return True
55
56
# ----------------------------------------------------------------------------------------------------------------------
57
NodeStore.register_inline_command('caption', CaptionNode)
58