Skip to content

Commit a4701a0

Browse files
committed
Remove @NoEffect annotations
+ Add missing asserts, where an expression statement was by itself that was intended as an assertion. This turned out to be the case in the places `@NoEffect` appeared in rendered documentation, making it so no per-file-ignores or other broadened suppressions were needed. + Fix misspellings (including one case affecting documentation). + Add a FIXME comment for investigating a free-standing expression statement with no obvious side effects that may have been meant as an assertion but would fail if turned into one.
1 parent d40320b commit a4701a0

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

Diff for: test/test_docs.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ def update(self, op_code, cur_count, max_count=None, message=""):
167167
open(new_file_path, "wb").close() # create new file in working tree
168168
cloned_repo.index.add([new_file_path]) # add it to the index
169169
# Commit the changes to deviate masters history
170-
cloned_repo.index.commit("Added a new file in the past - for later merege")
170+
cloned_repo.index.commit("Added a new file in the past - for later merge")
171171

172172
# prepare a merge
173173
master = cloned_repo.heads.master # right-hand side is ahead of us, in the future
@@ -198,7 +198,7 @@ def update(self, op_code, cur_count, max_count=None, message=""):
198198

199199
# .gitmodules was written and added to the index, which is now being committed
200200
cloned_repo.index.commit("Added submodule")
201-
assert sm.exists() and sm.module_exists() # this submodule is defintely available
201+
assert sm.exists() and sm.module_exists() # this submodule is definitely available
202202
sm.remove(module=True, configuration=False) # remove the working tree
203203
assert sm.exists() and not sm.module_exists() # the submodule itself is still available
204204

@@ -263,9 +263,9 @@ def test_references_and_objects(self, rw_dir):
263263
# [8-test_references_and_objects]
264264
hc = repo.head.commit
265265
hct = hc.tree
266-
hc != hct # noqa: B015 # @NoEffect
267-
hc != repo.tags[0] # noqa: B015 # @NoEffect
268-
hc == repo.head.reference.commit # noqa: B015 # @NoEffect
266+
assert hc != hct
267+
assert hc != repo.tags[0]
268+
assert hc == repo.head.reference.commit
269269
# ![8-test_references_and_objects]
270270

271271
# [9-test_references_and_objects]

Diff for: test/test_refs.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ def test_head_reset(self, rw_repo):
386386
head_tree = head.commit.tree
387387
self.assertRaises(ValueError, setattr, head, "commit", head_tree)
388388
assert head.commit == old_commit # and the ref did not change
389-
# we allow heds to point to any object
389+
# we allow heads to point to any object
390390
head.object = head_tree
391391
assert head.object == head_tree
392392
# cannot query tree as commit
@@ -489,7 +489,7 @@ def test_head_reset(self, rw_repo):
489489
cur_head.reference.commit,
490490
)
491491
# it works if the new ref points to the same reference
492-
assert SymbolicReference.create(rw_repo, symref.path, symref.reference).path == symref.path # @NoEffect
492+
assert SymbolicReference.create(rw_repo, symref.path, symref.reference).path == symref.path
493493
SymbolicReference.delete(rw_repo, symref)
494494
# would raise if the symref wouldn't have been deletedpbl
495495
symref = SymbolicReference.create(rw_repo, symref_path, cur_head.reference)

Diff for: test/test_submodule.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ def _do_base_tests(self, rwrepo):
111111

112112
# force it to reread its information
113113
del smold._url
114-
smold.url == sm.url # noqa: B015 # @NoEffect
114+
smold.url == sm.url # noqa: B015 # FIXME: Should this be an assertion?
115115

116116
# test config_reader/writer methods
117117
sm.config_reader()

0 commit comments

Comments
 (0)