Skip to content
This repository was archived by the owner on Nov 3, 2023. It is now read-only.

Commit 667d9be

Browse files
snudler6Nurdok
authored andcommitted
Allow skip on module level messages (#427)
* Added skip on module level messeges * Added the feature to release notes * Add ignore to D415 on test. * Added module errors skip feature via noqa to release notes (v2)
1 parent 8bfbf34 commit 667d9be

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

docs/release_notes.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ New Features
1818
* Extend support for detecting missing argument description in Numpy style
1919
docstrings (#407).
2020
* Added support for Python 3.8 (#423).
21+
* Allow skipping errors on module level docstring via #noqa (#427).
2122

2223
Bug Fixes
2324

src/pydocstyle/parser.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -505,6 +505,7 @@ def parse_module(self):
505505
"""Parse a module (and its children) and return a Module object."""
506506
self.log.debug("parsing module.")
507507
start = self.line
508+
skipped_error_codes = self.parse_skip_comment()
508509
docstring = self.parse_docstring()
509510
children = list(self.parse_definitions(Module, dunder_all=True))
510511
assert self.current is None, self.current
@@ -514,7 +515,7 @@ def parse_module(self):
514515
cls = Package
515516
module = cls(self.filename, self.source, start, end,
516517
[], docstring, children, None, self.dunder_all,
517-
self.dunder_all_error, None, '')
518+
self.dunder_all_error, None, skipped_error_codes)
518519
for child in module.children:
519520
child.parent = module
520521
module.future_imports = self.future_imports

src/tests/test_cases/noqa.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
"""Test case for "# noqa" comments."""
1+
# noqa: D400,D415
2+
"""Test case for "# noqa" comments"""
23
from .expected import Expectation
34

45

0 commit comments

Comments
 (0)