Move doc to docs. Fix doc compilation warnings.

[pithos] / pithos / backends / base.py

diff --git a/pithos/backends/base.py b/pithos/backends/base.py
index 109ee54..e592516 100644 (file)
--- a/pithos/backends/base.py
+++ b/pithos/backends/base.py
@@ -1,3 +1,36 @@
+# Copyright 2011 GRNET S.A. All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or
+# without modification, are permitted provided that the following
+# conditions are met:
+# 
+#   1. Redistributions of source code must retain the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer.
+# 
+#   2. Redistributions in binary form must reproduce the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer in the documentation and/or other materials
+#      provided with the distribution.
+# 
+# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
+# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# 
+# The views and conclusions contained in the software and
+# documentation are those of the authors and should not be
+# interpreted as representing official policies, either expressed
+# or implied, of GRNET S.A.
+
 class BaseBackend(object):
     """Abstract backend class that serves as a reference for actual implementations.
     
@@ -92,11 +125,11 @@ class BaseBackend(object):
             'delimiter': Return unique names before 'delimiter' and after 'prefix'
             'marker': Start list from the next item after 'marker'
             'limit': Number of objects to return
-            'virtual': If not set, the result will only include names starting
-                with 'prefix' and ending without a 'delimiter' or with the first
-                occurance of the 'delimiter' after 'prefix'.
-                If set, the result will include all names after 'prefix', up to and
-                including the 'delimiter' if it is found
+            'virtual': If not set, the result will only include names starting\
+                       with 'prefix' and ending without a 'delimiter' or with\
+                       the first occurance of the 'delimiter' after 'prefix'.\
+                       If set, the result will include all names after 'prefix',\
+                       up to and including the 'delimiter' if it is found
             'keys': Include objects that have meta with the keys in the list
         
         Raises:
@@ -131,8 +164,8 @@ class BaseBackend(object):
         """Update the metadata associated with the object.
         
         Parameters:
-            'meta': Dictionary with metadata to update.
-                Use the 'versioned' key to control versioning
+            'meta': Dictionary with metadata to update.\
+                    Use the 'versioned' key to control versioning
             'replace': Replace instead of update
         
         Raises: