Skip to content

Commit

Permalink
Remove @NoEffect annotations
Browse files Browse the repository at this point in the history
+ 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.
  • Loading branch information
EliahKagan committed Sep 21, 2023
1 parent d40320b commit a4701a0
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
10 changes: 5 additions & 5 deletions test/test_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ def update(self, op_code, cur_count, max_count=None, message=""):
open(new_file_path, "wb").close() # create new file in working tree
cloned_repo.index.add([new_file_path]) # add it to the index
# Commit the changes to deviate masters history
cloned_repo.index.commit("Added a new file in the past - for later merege")
cloned_repo.index.commit("Added a new file in the past - for later merge")

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

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

Expand Down Expand Up @@ -263,9 +263,9 @@ def test_references_and_objects(self, rw_dir):
# [8-test_references_and_objects]
hc = repo.head.commit
hct = hc.tree
hc != hct # noqa: B015 # @NoEffect
hc != repo.tags[0] # noqa: B015 # @NoEffect
hc == repo.head.reference.commit # noqa: B015 # @NoEffect
assert hc != hct
assert hc != repo.tags[0]
assert hc == repo.head.reference.commit
# ![8-test_references_and_objects]

# [9-test_references_and_objects]
Expand Down
4 changes: 2 additions & 2 deletions test/test_refs.py
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ def test_head_reset(self, rw_repo):
head_tree = head.commit.tree
self.assertRaises(ValueError, setattr, head, "commit", head_tree)
assert head.commit == old_commit # and the ref did not change
# we allow heds to point to any object
# we allow heads to point to any object
head.object = head_tree
assert head.object == head_tree
# cannot query tree as commit
Expand Down Expand Up @@ -489,7 +489,7 @@ def test_head_reset(self, rw_repo):
cur_head.reference.commit,
)
# it works if the new ref points to the same reference
assert SymbolicReference.create(rw_repo, symref.path, symref.reference).path == symref.path # @NoEffect
assert SymbolicReference.create(rw_repo, symref.path, symref.reference).path == symref.path
SymbolicReference.delete(rw_repo, symref)
# would raise if the symref wouldn't have been deletedpbl
symref = SymbolicReference.create(rw_repo, symref_path, cur_head.reference)
Expand Down
2 changes: 1 addition & 1 deletion test/test_submodule.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ def _do_base_tests(self, rwrepo):

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

# test config_reader/writer methods
sm.config_reader()
Expand Down

0 comments on commit a4701a0

Please sign in to comment.