Skip to content

Commit 470f265

Browse files
committed
added property deprecated_with_directive
1 parent dae5a76 commit 470f265

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

scripts/validate_docstrings.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -492,12 +492,14 @@ def first_line_ends_in_dot(self):
492492
if self.doc:
493493
return self.doc.split('\n')[0][-1] == '.'
494494

495+
@property
496+
def deprecated_with_directive(self):
497+
return ('.. deprecated:: ' in (self.summary + self.extended_summary))
498+
495499
@property
496500
def deprecated(self):
497-
pattern = re.compile('.. deprecated:: ')
498501
return (self.name.startswith('pandas.Panel')
499-
or bool(pattern.search(self.summary))
500-
or bool(pattern.search(self.extended_summary)))
502+
or self.deprecated_with_directive)
501503

502504
@property
503505
def mentioned_private_classes(self):
@@ -625,11 +627,9 @@ def get_validation_data(doc):
625627
errs.append(error('GL07',
626628
correct_sections=', '.join(correct_order)))
627629

628-
pattern = re.compile('.. deprecated:: ')
629-
if (bool(pattern.search(doc.summary))
630-
or bool(pattern.search(doc.extended_summary))):
631-
if not doc.extended_summary.startswith('.. deprecated:: '):
632-
errs.append(error('GL09'))
630+
if (doc.deprecated_with_directive
631+
and not doc.extended_summary.startswith('.. deprecated:: ')):
632+
errs.append(error('GL09'))
633633

634634
if not doc.summary:
635635
errs.append(error('SS01'))

0 commit comments

Comments
 (0)