Merge lp:~javier.collado/checkbox-core/shadowd-docstrings into lp:checkbox-core

[Javier Collado]

A few docstrings have been added for the shadowd package and its modules.

[Marc Tardif (cr3)]

I like how you once said that the docstring for a Python package or module should explain why it is there. It looks like the docstring in the checkbox.shadowd package tries to explain what it is doing, which would probably be better served by documentation under the doc/ directory. How would you feel about only keeping the first paragraph in that docstring?

review: Needs Information

[Marc Tardif (cr3)]

To merge this branch, I moved the second paragraph of your docstring from the checkbox.shadowd package to the doc/shadow.txt file. Then I added the corresponding entry in the doc/index.txt file. The rest looks good, so merging!

review: Approve

[Javier Collado (javier.collado)]

Thanks Marc. Sorry for not answering the question in the previous comment on time.

=== modified file 'checkbox/shadowd/__init__.py'
--- checkbox/shadowd/__init__.py	2012-04-24 22:43:09 +0000
+++ checkbox/shadowd/__init__.py	2012-04-26 13:49:23 +0000
@@ -0,0 +1,13 @@
+"""
+shadowd module implements the shadow daemon which is a process that runs on the
+client side to handle all the requests from the submit process to execute test
+cases.
+
+When a request is received, the shadow daemon connects to the portal process to
+ask which is the most appropriate runner daemon process that should be used to
+execute a given test case remotely. After that, the shadow daemon connects to
+the runner daemon to request the test case execution. Then the shadow daemon
+creates a new shadow process that connects to a new runner process created by
+the runner daemon so that they can take care of the execution and monitoring of
+the test case.
+"""

=== modified file 'checkbox/shadowd/client.py'
--- checkbox/shadowd/client.py	2012-04-24 22:43:09 +0000
+++ checkbox/shadowd/client.py	2012-04-26 13:49:23 +0000
@@ -16,6 +16,10 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
+"""
+The client module implements a Client class that can be used to communicate
+with a shadow daemon process
+"""
 __metaclass__ = type
 
 __all__ = [

=== modified file 'checkbox/shadowd/operation.py'
--- checkbox/shadowd/operation.py	2012-04-24 22:43:09 +0000
+++ checkbox/shadowd/operation.py	2012-04-26 13:49:23 +0000
@@ -16,6 +16,10 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
+"""
+The operation module defines the current set of commands that can be sent to a
+shadow daemon process
+"""
 __metaclass__ = type
 
 __all__ = [

=== modified file 'checkbox/shadowd/queue.py'
--- checkbox/shadowd/queue.py	2012-04-24 22:43:09 +0000
+++ checkbox/shadowd/queue.py	2012-04-26 13:49:23 +0000
@@ -16,6 +16,10 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
+"""
+The queue module implements a queue of requests that have not been sent yet to
+a runner daemon process
+"""
 __metaclass__ = type
 
 __all__ = [

=== modified file 'checkbox/shadowd/sender.py'
--- checkbox/shadowd/sender.py	2012-04-24 22:43:09 +0000
+++ checkbox/shadowd/sender.py	2012-04-26 13:49:23 +0000
@@ -16,6 +16,10 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
+"""
+The sender module provides an API for clients to send messages to the shadow
+daemon
+"""
 __metaclass__ = type
 
 __all__ = [