Skip to content

Commit 85ac4f7

Browse files
committed
Replaced for loop with regex match
1 parent 146fae1 commit 85ac4f7

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

scripts/validate_docstrings.py

+6-7
Original file line numberDiff line numberDiff line change
@@ -485,13 +485,12 @@ def parameter_desc_list(self, param):
485485
for line in self.doc._parsed_data['Parameters'][i][-1]
486486
if line]
487487
# Find and strip out any sphinx directives
488-
for directive in DIRECTIVES:
489-
full_directive = '.. {}'.format(directive)
490-
for desc_item in desc_list:
491-
if full_directive in desc_item:
492-
# Only retain any description before the directive
493-
desc_list = desc_list[:desc_list.index(desc_item)]
494-
break
488+
directives_pattern = re.compile('.. ({})'.format('|'.join(DIRECTIVES)))
489+
for desc_item in desc_list:
490+
if re.match(directives_pattern, desc_item):
491+
# Only retain any description before the directive
492+
desc_list = desc_list[:desc_list.index(desc_item)]
493+
break
495494
return desc_list
496495

497496
def has_proper_punctuation(self, param):

0 commit comments

Comments
 (0)