[med-svn] [python-mne] 322/376: some doc string

[Yaroslav Halchenko]

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

yoh pushed a commit to annotated tag v0.1
in repository python-mne.

commit 868b5bdc4b4db9a03a597d85ac3c1df57462aff7
Author: Alexandre Gramfort <alexandre.gramfort at inria.fr>
Date:   Thu Jul 7 13:38:52 2011 +0200

    some doc string
---
 mne/forward.py | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/mne/forward.py b/mne/forward.py
index 815a6d5..6b51ec5 100644
--- a/mne/forward.py
+++ b/mne/forward.py
@@ -34,9 +34,16 @@ def _block_diag(A, n):
     row matrix, where each set of n columns corresponds to a block element
     from the block diagonal.
 
-    Routine uses NO for-loops for speed considerations.
-
-    XXX : format doc
+    Parameters
+    ----------
+    A: array
+        The matrix
+    n: int
+        The block size
+    Returns
+    -------
+    bd: sparse matrix
+        The block diagonal matrix
     """
     from scipy import sparse
 

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