Skip to content

Commit 838a373

Browse files
committed
fixup! fixup! DOC: Add ignore_functions option to validate_docstrings.py
1 parent ff517c0 commit 838a373

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

scripts/tests/test_validate_docstrings.py

+10-4
Original file line numberDiff line numberDiff line change
@@ -339,14 +339,15 @@ def test_exit_status_for_main(self, monkeypatch):
339339
errors=[],
340340
output_format="default",
341341
ignore_deprecated=False,
342+
ignore_functions=None,
342343
)
343344
assert exit_status == 0
344345

345346
def test_exit_status_errors_for_validate_all(self, monkeypatch):
346347
monkeypatch.setattr(
347348
validate_docstrings,
348349
"validate_all",
349-
lambda prefix, ignore_deprecated=False: {
350+
lambda prefix, ignore_deprecated=False, ignore_functions=None: {
350351
"docstring1": {
351352
"errors": [
352353
("ER01", "err desc"),
@@ -369,14 +370,15 @@ def test_exit_status_errors_for_validate_all(self, monkeypatch):
369370
errors=[],
370371
output_format="default",
371372
ignore_deprecated=False,
373+
ignore_functions=None,
372374
)
373375
assert exit_status == 5
374376

375377
def test_no_exit_status_noerrors_for_validate_all(self, monkeypatch):
376378
monkeypatch.setattr(
377379
validate_docstrings,
378380
"validate_all",
379-
lambda prefix, ignore_deprecated=False: {
381+
lambda prefix, ignore_deprecated=False, ignore_functions=None: {
380382
"docstring1": {"errors": [], "warnings": [("WN01", "warn desc")]},
381383
"docstring2": {"errors": []},
382384
},
@@ -387,6 +389,7 @@ def test_no_exit_status_noerrors_for_validate_all(self, monkeypatch):
387389
errors=[],
388390
output_format="default",
389391
ignore_deprecated=False,
392+
ignore_functions=None,
390393
)
391394
assert exit_status == 0
392395

@@ -395,7 +398,7 @@ def test_exit_status_for_validate_all_json(self, monkeypatch):
395398
monkeypatch.setattr(
396399
validate_docstrings,
397400
"validate_all",
398-
lambda prefix, ignore_deprecated=False: {
401+
lambda prefix, ignore_deprecated=False, ignore_functions=None: {
399402
"docstring1": {
400403
"errors": [
401404
("ER01", "err desc"),
@@ -412,14 +415,15 @@ def test_exit_status_for_validate_all_json(self, monkeypatch):
412415
errors=[],
413416
output_format="json",
414417
ignore_deprecated=False,
418+
ignore_functions=None,
415419
)
416420
assert exit_status == 0
417421

418422
def test_errors_param_filters_errors(self, monkeypatch):
419423
monkeypatch.setattr(
420424
validate_docstrings,
421425
"validate_all",
422-
lambda prefix, ignore_deprecated=False: {
426+
lambda prefix, ignore_deprecated=False, ignore_functions=None: {
423427
"Series.foo": {
424428
"errors": [
425429
("ER01", "err desc"),
@@ -447,6 +451,7 @@ def test_errors_param_filters_errors(self, monkeypatch):
447451
errors=["ER01"],
448452
output_format="default",
449453
ignore_deprecated=False,
454+
ignore_functions=None,
450455
)
451456
assert exit_status == 3
452457

@@ -456,5 +461,6 @@ def test_errors_param_filters_errors(self, monkeypatch):
456461
errors=["ER03"],
457462
output_format="default",
458463
ignore_deprecated=False,
464+
ignore_functions=None,
459465
)
460466
assert exit_status == 1

0 commit comments

Comments
 (0)