Skip to content

Commit 5ff77f8

Browse files
committed
update test
1 parent 5e08541 commit 5ff77f8

File tree

2 files changed

+22
-11
lines changed

2 files changed

+22
-11
lines changed

src/custom_inherit/_doc_parse_tools/section_items.py

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,25 @@
99
except ImportError:
1010
# for Python < 3.3
1111
def indent(text, padding):
12-
return ''.join(padding+line for line in text.splitlines(True))
12+
return "".join(padding + line for line in text.splitlines(True))
1313

1414

15-
_RE_PATTERN_ITEMS = re.compile(
16-
r"(\**\w+)(.*?)(?:$|(?=\n\**\w+))", flags=re.DOTALL
17-
)
15+
_RE_PATTERN_ITEMS = re.compile(r"(\**\w+)(.*?)(?:$|(?=\n\**\w+))", flags=re.DOTALL)
1816

1917
_STYLE_TO_PADDING = {
2018
"numpy": "",
2119
"google": " " * 4,
2220
}
2321

24-
SECTION_NAMES = {"Attributes", "Parameters", "Methods", "Other Parameters", "Args",
25-
"Arguments"
26-
"Keyword Args", "Keyword Arguments"}
22+
SECTION_NAMES = {
23+
"Attributes",
24+
"Parameters",
25+
"Methods",
26+
"Other Parameters",
27+
"Args",
28+
"Arguments" "Keyword Args",
29+
"Keyword Arguments",
30+
}
2731

2832

2933
def _render(body, style):
@@ -68,7 +72,9 @@ def parse(doc_sections):
6872
for section_name in SECTION_NAMES:
6973
section_content = doc_sections[section_name]
7074
if section_content:
71-
doc_sections[section_name] = OrderedDict(_RE_PATTERN_ITEMS.findall(inspect.cleandoc(section_content)))
75+
doc_sections[section_name] = OrderedDict(
76+
_RE_PATTERN_ITEMS.findall(inspect.cleandoc(section_content))
77+
)
7278

7379

7480
def merge(prnt_sec, child_sec, merge_within_sections, style):

tests/inheritance_test.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,9 @@ class C(B):
137137
"""Testing C.
138138
139139
Args:
140+
a :
141+
priority description
142+
of a
140143
g :
141144
parameter g.
142145
h :
@@ -152,10 +155,11 @@ class C(B):
152155

153156
"""
154157
Testing C.
155-
158+
156159
Parameters:
157160
a :
158-
parameter a.
161+
priority description
162+
of a
159163
b :
160164
parameter b.
161165
c :
@@ -178,7 +182,8 @@ class C(B):
178182
179183
Notes:
180184
None"""
185+
181186
assert (
182187
C.__doc__
183-
== "Testing C.\n\nParameters:\n a :\n parameter a.\n b :\n parameter b.\n c :\n parameter c.\n d :\n parameter d.\n e :\n parameter e.\n f :\n parameter f.\n g :\n parameter g.\n h :\n parameter h.\n i :\n parameter i.\n\nReturns:\n None\n\nNotes:\n None"
188+
== "Testing C.\n\nParameters:\n a :\n priority description\n of a\n b :\n parameter b.\n c :\n parameter c.\n d :\n parameter d.\n e :\n parameter e.\n f :\n parameter f.\n g :\n parameter g.\n h :\n parameter h.\n i :\n parameter i.\n\nReturns:\n None\n\nNotes:\n None"
184189
)

0 commit comments

Comments
 (0)