diff options
| author | danicampora | 2016-02-22 22:51:22 +0100 |
|---|---|---|
| committer | danicampora | 2016-02-22 22:54:34 +0100 |
| commit | add930c4b5baa029d454f78c6c6a14093b1d902f (patch) | |
| tree | 8a54979fb69d88ec1fcfaf2670f403567e2bc8ae /docs | |
| parent | 12547ce737741bab006900c8e325b86c955e057e (diff) | |
cc3200: Rename 'server' class to 'Server' for consistency.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/library/network.rst | 14 | ||||
| -rw-r--r-- | docs/wipy/quickref.rst | 6 |
2 files changed, 10 insertions, 10 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. diff --git a/docs/wipy/quickref.rst b/docs/wipy/quickref.rst index 6c2cf0de7..a2886e78c 100644 --- a/docs/wipy/quickref.rst +++ b/docs/wipy/quickref.rst @@ -201,12 +201,12 @@ See :ref:`network.WLAN <network.WLAN>` and :mod:`machine`. :: Telnet and FTP server --------------------- -See :ref:`network.server <network.server>` :: +See :ref:`network.Server <network.Server>` :: - from network import server + from network import Server # init with new user, password and seconds timeout - server = server.init(login=('user', 'password'), timeout=60) + server = Server(login=('user', 'password'), timeout=60) server.timeout(300) # change the timeout server.timeout() # get the timeout server.isrunning() # check wether the server is running or not |
