[med-svn] [python-mne] 87/353: DOC : docstring formatting

[Yaroslav Halchenko]

This is an automated email from the git hooks/post-receive script.

yoh pushed a commit to tag 0.4
in repository python-mne.

commit 929209043f38be1472029de4fc249e6cc00d5791
Author: Alexandre Gramfort <alexandre.gramfort at inria.fr>
Date:   Tue Feb 28 10:52:12 2012 +0100

    DOC : docstring formatting
---
 mne/fiff/raw.py | 32 +++++++++++++-------------------
 1 file changed, 13 insertions(+), 19 deletions(-)

diff --git a/mne/fiff/raw.py b/mne/fiff/raw.py
index 05cd1fe..e835485 100644
--- a/mne/fiff/raw.py
+++ b/mne/fiff/raw.py
@@ -16,7 +16,7 @@ from .tag import read_tag
 
 
 class Raw(object):
-    """Raw data set
+    """Raw data
 
     Parameters
     ----------
@@ -26,29 +26,23 @@ class Raw(object):
     allow_maxshield: bool, (default False)
         allow_maxshield if True XXX ???
 
+    preload: bool or str (default False)
+        Preload data into memory for data manipulation and faster indexing.
+        If True, the data will be preloaded into memory (fast, requires
+        large amount of memory). If preload is a string, preload is the
+        file name of a memory-mapped file which is used to store the data
+        on the hard drive (slower, requires less memory).
+
+    Attributes
+    ----------
     info: dict
-        Infos about raw data
+        Measurement info
 
+    ch_names: list of string
+        List of channels' names
     """
 
     def __init__(self, fname, allow_maxshield=False, preload=False):
-        """
-        Parameters
-        ----------
-        fname: string
-            The name of the raw file
-
-        allow_maxshield: bool, (default False)
-            allow_maxshield if True XXX ???
-
-        preload: bool or str (default False)
-            Preload data into memory for data manipulation and faster indexing.
-            If True, the data will be preloaded into memory (fast, requires
-            large amount of memory). If preload is a string, preload is the
-            file name of a memory-mapped file which is used to store the data
-            on the hard drive (slower, requires less memory).
-        """
-
         #   Open the file
         print 'Opening raw data file %s...' % fname
         fid, tree, _ = fiff_open(fname)

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/python-mne.git