SectionNode.__init__() - Code Metrics - Inspection of "Merge branch 'master' of github.com:SDoc/py-sdoc" - SDoc/py-sdoc - Measure and Improve Code Quality continuously with Scrutinizer

Passed

by P.R.

created 2016-06-15 13:01 UTC

↳ Parent: SectionNode

Conditions

Total Lines

Lines	0
Ratio	0 %

Changes	1
Bugs	0	Features	0

1			"""
2			SDoc
3
4			Copyright 2016 Set Based IT Consultancy
5
6			Licence MIT
7			"""
8			# ----------------------------------------------------------------------------------------------------------------------
9			from sdoc.sdoc2 import node_store
10			from sdoc.sdoc2.node.HeadingNode import HeadingNode
11
12
13			class SectionNode(HeadingNode):
14			"""
15			SDoc2 node for sections.
16			"""
17			# ------------------------------------------------------------------------------------------------------------------
18			def __init__(self, options, argument):
19			"""
20			Object constructor.
21
22			:param dict[str,str] options: The options of this section.
23			:param str argument: The title of this section.
24			"""
25			super().__init__('section', options, argument)
26
27			# ------------------------------------------------------------------------------------------------------------------
28			def get_command(self):
29			"""
30			Returns the command of this node, i.e. section.
31
32			:rtype: str
33			"""
34			return 'section'
35
36			# ------------------------------------------------------------------------------------------------------------------
37			def get_hierarchy_level(self, parent_hierarchy_level=-1):
38			"""
39			Returns 2.
40
41			:rtype: int
42			"""
43			return 2
44
45
46			# ----------------------------------------------------------------------------------------------------------------------
47			node_store.register_inline_command('section', SectionNode)
48

SDoc / py-sdoc