Skip to content

Commit

Permalink
Better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Kegan Dougal committed Nov 20, 2023
1 parent 4529ba5 commit 8e45f46
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion test_package.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ type Deployment interface {
StopServer(t *testing.T, hsName string)
// Start the container running this HS. The HS must exist in this deployment already and it must be stopped already.
// Fails the test if this isn't true, or there was a problem.
// This function is designed to be used to make assertions when federated servers are unreachable.
// This function is designed to be used to start a server previously stopped via StopServer.
// Do not use this function if you need the HS CSAPI URL to be stable, prefer UnpauseServer if you need this.
StartServer(t *testing.T, hsName string)
// Pause a running homeserver. The HS will be suspended, preserving data in memory.
Expand Down

0 comments on commit 8e45f46

Please sign in to comment.