aboutsummaryrefslogtreecommitdiff
path: root/docs/library
diff options
context:
space:
mode:
authordanicampora2016-02-22 22:51:22 +0100
committerdanicampora2016-02-22 22:54:34 +0100
commitadd930c4b5baa029d454f78c6c6a14093b1d902f (patch)
tree8a54979fb69d88ec1fcfaf2670f403567e2bc8ae /docs/library
parent12547ce737741bab006900c8e325b86c955e057e (diff)
cc3200: Rename 'server' class to 'Server' for consistency.
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/network.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/library/network.rst b/docs/library/network.rst
index 11e7a2a41..6b72ad2c6 100644
--- a/docs/library/network.rst
+++ b/docs/library/network.rst
@@ -30,27 +30,27 @@ For example::
.. only:: port_wipy
- .. _network.server:
+ .. _network.Server:
- class server
+ class Server
============
- The server class controls the behaviour and the configuration of the FTP and telnet
+ The ``Server`` class controls the behaviour and the configuration of the FTP and telnet
services running on the WiPy. Any changes performed using this class' methods will
affect both.
Example::
import network
- s = network.server()
- s.deinit() # disable the server
+ server = network.Server()
+ server.deinit() # disable the server
# enable the server again with new settings
- s.init(login=('user', 'password'), timeout=600)
+ server.init(login=('user', 'password'), timeout=600)
Constructors
------------
- .. class:: network.server(id, ...)
+ .. class:: network.Server(id, ...)
Create a server instance, see ``init`` for parameters of initialization.