Revision: e57d6170f8f9
Branch: default
Author: Pekka Klärck
Date: Wed Apr 23 13:57:05 2014 UTC
Log: Remote API: Document that stop_remote_server should return
True/False.
Update issue 1682
Status: Done
Labels: Priority-Low
http://code.google.com/p/robotframework/source/detail?r=e57d6170f8f9
Modified:
/doc/userguide/src/ExtendingRobotFramework/RemoteLibrary.rst
=======================================
--- /doc/userguide/src/ExtendingRobotFramework/RemoteLibrary.rst Thu Jan 23
13:28:38 2014 UTC
+++ /doc/userguide/src/ExtendingRobotFramework/RemoteLibrary.rst Wed Apr 23
13:57:05 2014 UTC
@@ -226,11 +226,13 @@
Remote servers should additionally have :code:`stop_remote_server`
method in their public interface to ease stopping them. They should
-also expose this method as :name:`Stop Remote Server` keyword
-automatically so that it can be used in the test data regardless of
-the test library. Allowing users to stop the server using these
-methods is not always desirable, and servers can choose to allow
-disabling them via some configuration parameter.
+also automatically expose this method as :name:`Stop Remote Server`
+keyword to allow using it in the test data regardless of the test
+library. Allowing users to stop the server is not always desirable,
+and servers may support disabling this functionality somehow.
+The method, and also the exposed keyword, should return :code:`True`
+or :code:`False` depending was stopping allowed or not. That makes it
+possible for external tools to know did stopping the server succeed.
The provided Python remote server can be used as a reference
implementation.
--
---
You received this message because you are subscribed to the Google Groups "robotframework-commit" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
For more options, visit https://groups.google.com/d/optout.
