[med-svn] [python-mne] 330/353: DOC: note on brain_vision2fiff

[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 8966cfe936942c1380c531fb04f93f0201ec2055
Author: Christian Brodbeck <christianmbrodbeck at gmail.com>
Date:   Mon Jul 30 18:13:16 2012 -0400

    DOC: note on brain_vision2fiff
---
 doc/source/manual/convert.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/source/manual/convert.rst b/doc/source/manual/convert.rst
index 71ddef2..ecdde39 100644
--- a/doc/source/manual/convert.rst
+++ b/doc/source/manual/convert.rst
@@ -803,6 +803,13 @@ toolbox contains the function fiff_write_dig_file to
 write a digitization file based on digitization data available in
 another format, see :ref:`ch_matlab`.
 
+.. Note:: 
+    
+    mne_brain_vision2fiff reads events from the ``vmrk`` file referenced in the
+    ``vhdr`` file, but it only includes events whose "Type" is ``Stimulus`` and
+    whose "description" is given by ``S<number>``. All other events are ignored.
+
+
 The command-line options of mne_brain_vision2fiff are:
 
 **\---version**

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