From 6f90f6705c09ea861a783d1e474a55c90be0dad0 Mon Sep 17 00:00:00 2001
From: "Rafael G. Martins" <rafael@rafaelmartins.eng.br>
Date: Fri, 10 Dec 2010 10:34:41 -0200
Subject: fixed some docstrings

---
 g_octave/checksum.py         | 4 ++--
 g_octave/compat.py           | 2 ++
 g_octave/description.py      | 4 ++--
 g_octave/description_tree.py | 4 ++--
 g_octave/ebuild.py           | 4 ++--
 g_octave/fetch.py            | 4 ++--
 g_octave/log.py              | 4 ++--
 g_octave/overlay.py          | 4 ++--
 g_octave/package_manager.py  | 4 ++--
 9 files changed, 18 insertions(+), 16 deletions(-)

diff --git a/g_octave/checksum.py b/g_octave/checksum.py
index 3ff8406..1925da9 100644
--- a/g_octave/checksum.py
+++ b/g_octave/checksum.py
@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 
 """
-    checksum.py
-    ~~~~~~~~~~~
+    g_octave.checksum
+    ~~~~~~~~~~~~~~~~~
     
     This module implements functions for compute/generate SHA1 checksums
     for DESCRIPTION files.
diff --git a/g_octave/compat.py b/g_octave/compat.py
index aa45207..ec364c3 100644
--- a/g_octave/compat.py
+++ b/g_octave/compat.py
@@ -19,9 +19,11 @@ __all__ = [
 import codecs
 import sys
 
+
 py3k = sys.version_info >= (3, 0)
 
 def open(filename, mode='r', encoding='utf-8'):
+    '''custom implementation of the 'open' builtin, using the codecs module'''
     try:
         return codecs.open(filename, mode=mode, encoding=encoding)
     except:
diff --git a/g_octave/description.py b/g_octave/description.py
index dde116d..16713e3 100644
--- a/g_octave/description.py
+++ b/g_octave/description.py
@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 
 """
-    description.py
-    ~~~~~~~~~~~~~~
+    g_octave.description
+    ~~~~~~~~~~~~~~~~~~~~
 
     This module implements a Python object with the content of a given
     DESCRIPTION file.
diff --git a/g_octave/description_tree.py b/g_octave/description_tree.py
index e65f8b0..7b27b35 100644
--- a/g_octave/description_tree.py
+++ b/g_octave/description_tree.py
@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 
 """
-    description_tree.py
-    ~~~~~~~~~~~~~~~~~~~
+    g_octave.description_tree
+    ~~~~~~~~~~~~~~~~~~~~~~~~~
     
     This module implements a Python object with the content of a directory
     tree with DESCRIPTION files. The object contains *g_octave.Description*
diff --git a/g_octave/ebuild.py b/g_octave/ebuild.py
index 0c5a780..4906ce2 100644
--- a/g_octave/ebuild.py
+++ b/g_octave/ebuild.py
@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 
 """
-    ebuild.py
-    ~~~~~~~~~
+    g_octave.ebuild
+    ~~~~~~~~~~~~~~~
     
     This module implements a Python class responsible to create the ebuilds
     for the octave-forge packages and track the dependencies correctly.
diff --git a/g_octave/fetch.py b/g_octave/fetch.py
index 0a35852..b43b585 100644
--- a/g_octave/fetch.py
+++ b/g_octave/fetch.py
@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 
 """
-    fetch.py
-    ~~~~~~~~
+    g_octave.fetch
+    ~~~~~~~~~~~~~~
     
     This module implements a Python class responsible to fetch and update
     the package database and the auxiliary files.
diff --git a/g_octave/log.py b/g_octave/log.py
index 2473bc0..2a98e31 100644
--- a/g_octave/log.py
+++ b/g_octave/log.py
@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 
 """
-    log.py
-    ~~~~~~
+    g_octave.log
+    ~~~~~~~~~~~~
     
     A simple Python module to deal with g-octave logging stuff.
     
diff --git a/g_octave/overlay.py b/g_octave/overlay.py
index 49984f3..b7a267f 100644
--- a/g_octave/overlay.py
+++ b/g_octave/overlay.py
@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 
 """
-    overlay.py
-    ~~~~~~~~~~
+    g_octave.overlay
+    ~~~~~~~~~~~~~~~~
     
     This module implements a function to create an overlay to host the
     ebuilds generated by g-octave.
diff --git a/g_octave/package_manager.py b/g_octave/package_manager.py
index 14503ba..6c804c3 100644
--- a/g_octave/package_manager.py
+++ b/g_octave/package_manager.py
@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 
 """
-    package_manager.py
-    ~~~~~~~~~~~~~~~~~~
+    g_octave.package_manager
+    ~~~~~~~~~~~~~~~~~~~~~~~~
 
     This module implements some Python classes for the implementation of
     the multiple package manager support.
-- 
cgit v1.2.3-65-gdbad