Skip to content

Commit 6b6a0f0

Browse files
committed
Short sentence about avoiding restarts
Keep the documentation short.
1 parent d640ae8 commit 6b6a0f0

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ username and password.)
4646

4747
The port of the server is obtained by `sftpServer.getPort()`. You can change it
4848
by calling `setPort(int)`. If you do this from within a test then the server
49-
gets restarted. Therefore I recommend to set the port immediately after
50-
creating the rule in order to avoid the time consuming restart.
49+
gets restarted. The time-consuming restart can be avoided by setting the port
50+
immediately after creating the rule.
5151

5252
public class TestClass {
5353
@Rule

src/main/java/com/github/stefanbirkner/fakesftpserver/rule/FakeSftpServerRule.java

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@
3939
* <p>The port of the server is obtained by
4040
* {@link #getPort() sftpServer.getPort()}. You can change it by calling
4141
* {@link #setPort(int)}. If you do this from within a test then the server gets
42-
* restarted. Therefore it is recommended to set the port immediately after
43-
* creating the rule in order to avoid the time consuming restart.
42+
* restarted. The time-consuming restart can be avoided by setting the port
43+
* immediately after creating the rule.
4444
* <pre>
4545
* public class TestClass {
4646
* &#064;Rule
@@ -140,9 +140,8 @@ public int getPort() {
140140

141141
/**
142142
* Set the port of the SFTP server. The SFTP server gets restarted if you
143-
* call {@code setPort} from within a test. It is recommended to set the
144-
* port immediately after creating the rule in order to avoid the time
145-
* consuming restart.
143+
* call {@code setPort} from within a test. The time-consuming restart can
144+
* be avoided by setting the port immediately after creating the rule.
146145
* @param port the port. Must be between 1 and 65535.
147146
* @return the rule itself.
148147
* @throws IllegalArgumentException if the port is not between 1 and 65535.

0 commit comments

Comments
 (0)