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

Commit 51bfb1d

Browse files
committed
Added a test.
1 parent 28a119b commit 51bfb1d

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

pep257.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,11 @@ def __str__(self):
141141
return 'at module level'
142142

143143

144+
class Package(Module):
145+
146+
"""A package is a __init__.py module."""
147+
148+
144149
class Function(Definition):
145150

146151
_nest = staticmethod(lambda s: {'def': NestedFunction,

test_pep257.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,3 +279,13 @@ def foo():
279279
assert code == 0
280280
assert 'D301' not in err
281281
assert 'D302' not in err
282+
283+
284+
def test_missing_docstring_in_package():
285+
with Pep257Env() as env:
286+
with env.open('__init__.py', 'wt') as init:
287+
pass # an empty package file
288+
out, err, code = env.invoke_pep257()
289+
assert code == 1
290+
assert 'D100' not in err # shouldn't be treated as a module
291+
assert 'D104' in err # missing docstring in package

0 commit comments

Comments
 (0)