Clarify test_forget_when_not_left docstring (#17628)

anoadragon453 · web-flow · commit e8c8924b810f · 2024-10-07T16:34:32.000+01:00
diff --git a/changelog.d/17628.doc b/changelog.d/17628.doc
@@ -0,0 +1 @@
+Clarify the docstring of `test_forget_when_not_left`.
diff --git a/tests/handlers/test_room_member.py b/tests/handlers/test_room_member.py
@@ -380,7 +380,7 @@ def test_leave_and_forget_last_user(self) -> None:
         )
 
     def test_forget_when_not_left(self) -> None:
-        """Tests that a user cannot not forgets a room that has not left."""
+        """Tests that a user cannot forget a room that they are still in."""
         self.get_failure(self.handler.forget(self.alice_ID, self.room_id), SynapseError)
 
     def test_nonlocal_room_user_action(self) -> None:

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Clarify the docstring of `test_forget_when_not_left`.
Original file line number	Diff line number	Diff line change
`@@ -380,7 +380,7 @@ def test_leave_and_forget_last_user(self) -> None:`
`380`	`380`	`)`
`381`	`381`
`382`	`382`	`def test_forget_when_not_left(self) -> None:`
`383`		`- """Tests that a user cannot not forgets a room that has not left."""`
	`383`	`+ """Tests that a user cannot forget a room that they are still in."""`
`384`	`384`	`self.get_failure(self.handler.forget(self.alice_ID, self.room_id), SynapseError)`
`385`	`385`
`386`	`386`	`def test_nonlocal_room_user_action(self) -> None:`