Skip to content

Commit 864bca4

Browse files
Fix grammar typo in serverNames arg docstring (#890)
1 parent 0e6f855 commit 864bca4

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

client/client.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ func (c *CSAPI) UpgradeRoom(t ct.TestLike, roomID string, newVersion string) *ht
203203
//
204204
// Args:
205205
// - `serverNames`: The list of servers to attempt to join the room through.
206-
// These should be a resolvable addresses within the deployment network.
206+
// These should be a resolvable address within the deployment network.
207207
func (c *CSAPI) MustJoinRoom(t ct.TestLike, roomIDOrAlias string, serverNames []spec.ServerName) string {
208208
t.Helper()
209209
res := c.JoinRoom(t, roomIDOrAlias, serverNames)
@@ -221,7 +221,7 @@ func (c *CSAPI) MustJoinRoom(t ct.TestLike, roomIDOrAlias string, serverNames []
221221
//
222222
// Args:
223223
// - `serverNames`: The list of servers to attempt to join the room through.
224-
// These should be a resolvable addresses within the deployment network.
224+
// These should be a resolvable address within the deployment network.
225225
func (c *CSAPI) JoinRoom(t ct.TestLike, roomIDOrAlias string, serverNames []spec.ServerName) *http.Response {
226226
t.Helper()
227227
// construct URL query parameters

federation/server.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ func (s *Server) FederationClient(deployment FederationDeployment) fclient.Feder
241241
// for any sent PDUs. Times out after 10 seconds.
242242
//
243243
// Args:
244-
// - `destination`: This should be a resolvable addresses within the deployment network.
244+
// - `destination`: This should be a resolvable address within the deployment network.
245245
func (s *Server) MustSendTransaction(t ct.TestLike, deployment FederationDeployment, destination spec.ServerName, pdus []json.RawMessage, edus []gomatrixserverlib.EDU) {
246246
t.Helper()
247247
fedClient := s.FederationClient(deployment)
@@ -361,7 +361,7 @@ func (s *Server) MustCreateEvent(t ct.TestLike, room *ServerRoom, ev Event) goma
361361
// It returns the resultant room.
362362
//
363363
// Args:
364-
// - `remoteServer`: This should be a resolvable addresses within the deployment network.
364+
// - `remoteServer`: This should be a resolvable address within the deployment network.
365365
func (s *Server) MustJoinRoom(t ct.TestLike, deployment FederationDeployment, remoteServer spec.ServerName, roomID string, userID string, opts ...JoinRoomOpt) *ServerRoom {
366366
t.Helper()
367367
var jr joinRoom
@@ -446,7 +446,7 @@ func (s *Server) MustJoinRoom(t ct.TestLike, deployment FederationDeployment, re
446446
// Leaves a room. If this is rejecting an invite then a make_leave request is made first, before send_leave.
447447
//
448448
// Args:
449-
// - `remoteServer`: This should be a resolvable addresses within the deployment network.
449+
// - `remoteServer`: This should be a resolvable address within the deployment network.
450450
func (s *Server) MustLeaveRoom(t ct.TestLike, deployment FederationDeployment, remoteServer spec.ServerName, roomID string, userID string) {
451451
t.Helper()
452452
origin := spec.ServerName(s.serverName)

tests/knocking_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ func knockingBetweenTwoUsersTest(
303303
//
304304
// Args:
305305
// - `serverNames`: The list of servers to attempt to knock on the room through.
306-
// These should be a resolvable addresses within the deplyment network.
306+
// These should be a resolvable address within the deployment network.
307307
func mustKnockOnRoomSynced(t *testing.T, c *client.CSAPI, roomID, reason string, serverNames []spec.ServerName) {
308308
knockOnRoomWithStatus(t, c, roomID, reason, serverNames, 200)
309309

@@ -317,7 +317,7 @@ func mustKnockOnRoomSynced(t *testing.T, c *client.CSAPI, roomID, reason string,
317317
//
318318
// Args:
319319
// - `serverNames`: The list of servers to attempt to knock on the room through.
320-
// These should be a resolvable addresses within the deployment network.
320+
// These should be a resolvable address within the deployment network.
321321
func knockOnRoomWithStatus(t *testing.T, c *client.CSAPI, roomID, reason string, serverNames []spec.ServerName, expectedStatus int) {
322322
b := []byte("{}")
323323
var err error

0 commit comments

Comments
 (0)