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

[Javier Collado]

Added small docstring for every package

Please feel free to fix/improve it.

[Marc Tardif (cr3)]

For future commits, I would prefer if module docstrings were after the copyright like in other projects like Storm, Launchpad, etc. Since there was no precedent for this ordering in the current code base, I just moved your docstring while reviewing. I also took the liberty of changing some text, all of which is now merged and pushed to trunk. Thanks!

review: Approve

[Javier Collado (javier.collado)]

I'll take the ordering into account. Thanks for your comment.

=== modified file 'checkbox/__init__.py'
--- checkbox/__init__.py	2012-04-23 19:36:19 +0000
+++ checkbox/__init__.py	2012-04-24 16:23:51 +0000
@@ -1,3 +1,7 @@
+"""
+checkbox provides the ability to run test cases and collect results in a
+distributed environment.
+"""
 #
 # Copyright (c) 2012 Canonical
 #

=== modified file 'checkbox/connector/__init__.py'
--- checkbox/connector/__init__.py	2012-02-24 15:53:59 +0000
+++ checkbox/connector/__init__.py	2012-04-24 16:23:51 +0000
@@ -0,0 +1,5 @@
+"""
+The connector package implements the mechanisms needed to communicate between
+processes that aren't reachable using the conventional methods because they
+aren't directly connected to each other.
+"""

=== modified file 'checkbox/daemon/__init__.py'
--- checkbox/daemon/__init__.py	2012-04-11 21:22:52 +0000
+++ checkbox/daemon/__init__.py	2012-04-24 16:23:51 +0000
@@ -0,0 +1,4 @@
+"""
+The daemon package provides the set of tools needed to create daemon processes
+that implement the services needed under a distributed testing architecture.
+"""

=== modified file 'checkbox/io/__init__.py'
--- checkbox/io/__init__.py	2012-02-24 15:53:59 +0000
+++ checkbox/io/__init__.py	2012-04-24 16:23:51 +0000
@@ -0,0 +1,4 @@
+"""
+The io package exposes the basic facilities to communicate between processes
+that are reachable in a computer network.
+"""

=== modified file 'checkbox/journal/__init__.py'
--- checkbox/journal/__init__.py	2012-04-12 18:58:39 +0000
+++ checkbox/journal/__init__.py	2012-04-24 16:23:51 +0000
@@ -0,0 +1,4 @@
+"""
+The journal package keeps track of the activity in the testing environment to
+make it possible to rollback to a known state in case of a failure.
+"""

=== modified file 'checkbox/lib/__init__.py'
--- checkbox/lib/__init__.py	2012-02-10 04:47:41 +0000
+++ checkbox/lib/__init__.py	2012-04-24 16:23:51 +0000
@@ -0,0 +1,4 @@
+"""
+The lib package provides a set of tools in separate modules that can be used
+anywhere in the code.
+"""

=== modified file 'checkbox/message/__init__.py'
--- checkbox/message/__init__.py	2012-02-10 04:47:41 +0000
+++ checkbox/message/__init__.py	2012-04-24 16:23:51 +0000
@@ -0,0 +1,4 @@
+"""
+The message module implements the methods to encode/decode the messages
+exchanged between the processes in the testing environment.
+"""

=== modified file 'checkbox/process/__init__.py'
--- checkbox/process/__init__.py	2012-04-11 21:22:52 +0000
+++ checkbox/process/__init__.py	2012-04-24 16:23:51 +0000
@@ -0,0 +1,4 @@
+"""
+The process package exposes the functionality required to create and monitor
+processes.
+"""

=== modified file 'checkbox/runner/__init__.py'
--- checkbox/runner/__init__.py	2012-04-18 14:19:54 +0000
+++ checkbox/runner/__init__.py	2012-04-24 16:23:51 +0000
@@ -0,0 +1,3 @@
+"""
+The runner package takes care of running test cases and return their results
+"""

=== modified file 'checkbox/scripts/__init__.py'
--- checkbox/scripts/__init__.py	2012-02-24 15:53:59 +0000
+++ checkbox/scripts/__init__.py	2012-04-24 16:23:51 +0000
@@ -0,0 +1,4 @@
+"""
+The scripts package is the entry point for the processes launched during the
+testing session.
+"""

=== modified file 'checkbox/scripts/mixins/__init__.py'
--- checkbox/scripts/mixins/__init__.py	2012-02-24 15:53:59 +0000
+++ checkbox/scripts/mixins/__init__.py	2012-04-24 16:23:51 +0000
@@ -0,0 +1,4 @@
+"""
+The scripts.mixins offers a set of classes that implement patterns that can be
+reused in the scripts package.
+"""