Skip to content

Commit 6c66934

Browse files
committed
Update comment to be more explicit
1 parent 8349817 commit 6c66934

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

test/unit/util/release/changelog_test.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,10 @@ def changelogs(tmp_path) -> Changelogs:
7777

7878
class TestChangelogs:
7979
"""
80-
As some methods in the class `Changelogs` modify files. The tests need to reset
81-
these fixtures per function.
80+
As some methods in the class `Changelogs` modify files, it is required that the
81+
fixtures which create the sample files (changelog.md, unreleased.md, & changes_1.0.0.md)
82+
reset per function and use `tmp_path`. By doing this, we ensure that the sample
83+
are in their expected state for each test.
8284
"""
8385

8486
@staticmethod

0 commit comments

Comments
 (0)