update doc

Author: cx1111

README.rst

@@ -3,13 +3,14 @@ wfdb-python
 
 |Build Status|
 
-.. figure:: https://raw.githubusercontent.com/MIT-LCP/wfdb-python/master/demoimg.png
+.. figure:: https://raw.githubusercontent.com/MIT-LCP/wfdb-python/master/demo-img.png
    :alt: wfdb signals
 
+
 Introduction
 ------------
 
-The native Python waveform-database (WFDB) package. A library of tools for reading and writing WFDB signals and annotations, and general physiological signal processing.
+The native Python waveform-database (WFDB) package. A library of tools for reading, writing, and processing WFDB signals and annotations.
 
 Core components of this package are based on the original WFDB specifications:
 
@@ -19,33 +20,68 @@ Core components of this package are based on the original WFDB specifications:
 | `WFDB Signal Specifications`_
 | `WFDB Annotation Specifications`_
 
+This package does not contain the exact same functionality as the original WFDB package. It aims to implement as many of its core features as possible, with user-friendly APIs. Additional useful physiological signal-processing tools are added over time.
+
+
+Development
+-----------
+
+The development repository is hosted at: https://github.com/MIT-LCP/wfdb-python
+
+The package is to be expanded with physiological signal-processing tools, and general improvements. Support is provided for Python 2.7 and 3.5+ only.
+
+
+Contributing
+------------
+
+We welcome community contributions in the form of pull requests. When contributing code, please ensure:
+
+* PEP8_ style guidelines are followed.
+* Documentation is provided. New functions and classes should have numpy/scipy style docstrings_. 
+* Unit tests are written for new features that are not covered by `existing tests`_.
+
+
 Installation
 ------------
 
-The distribution is hosted on pypi at: https://pypi.python.org/pypi/wfdb/ and directly installable via pip without needing clone or download this repository. Note that the pypi package does not contain the demo scripts or the example data. To install the package from pypi, run from your terminal:
-``pip install wfdb``
+The distribution is hosted on pypi at: https://pypi.python.org/pypi/wfdb/. To directly install the package from pypi without needing to explicitly download content, run from your terminal::
+
+    $ pip install wfdb
 
-Download or clone this repository: https://github.com/MIT-LCP/wfdb-python for the latest development version, the demo scripts, and the example data. To install the downloaded package, navigate to the base directory of the repository and run:
-``pip install .``
+The development version is hosted at: https://github.com/MIT-LCP/wfdb-python. This repository also contains demo scripts and example data. To install the development version, clone or download the repository, navigate to the base directory, and run::
+
+    $ pip install .
 
 
 Documentation and Usage
 -----------------------
 
-See the documentation site for public classes and functions. 
+See the documentation site for public classes and functions.
 
-See the **demo.ipynb** file for example use cases.
+See the `demo.ipynb`_ notebook file for more example use cases.
 
 
+Authors
+-------
 
+- `Chen Xie`_
+- `Julien Dubiel`_
 
 
+.. |Build Status| image:: https://travis-ci.org/MIT-LCP/wfdb-python.svg?branch=master
+   :target: https://travis-ci.org/MIT-LCP/wfdb-python
 
 .. _WFDB Software Package: http://physionet.org/physiotools/wfdb.shtml
 .. _WFDB Applications Guide: http://physionet.org/physiotools/wag/
 .. _WFDB Header Specifications: https://physionet.org/physiotools/wag/header-5.htm
 .. _WFDB Signal Specifications: https://physionet.org/physiotools/wag/signal-5.htm
 .. _WFDB Annotation Specifications: https://physionet.org/physiotools/wag/annot-5.htm
 
-.. |Build Status| image:: https://travis-ci.org/MIT-LCP/wfdb-python.svg?branch=master
-   :target: https://travis-ci.org/MIT-LCP/wfdb-python
+.. _PEP8: https://www.python.org/dev/peps/pep-0008/
+.. _docstrings: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
+.. _existing tests: https://github.com/MIT-LCP/wfdb-python/tree/master/tests
+
+.. _demo.ipynb: https://github.com/MIT-LCP/wfdb-python/blob/master/demo.ipynb
+
+.. _Chen Xie: https://github.com/cx1111/
+.. _Julien Dubiel: https://github.com/Dubrzr/

demoimg.png demo-img.png

@@ -10,6 +10,7 @@ Welcome to wfdb's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   installation
    io
    plot
    processing

docs/index.rst

@@ -0,0 +1,10 @@
+Installation
+------------
+
+The distribution is hosted on pypi at: https://pypi.python.org/pypi/wfdb/. To directly install the package from pypi without needing to explicitly download content, run from your terminal::
+
+    $ pip install wfdb
+
+The development version is hosted at: https://github.com/MIT-LCP/wfdb-python. This repository also contains demo scripts and example data. To install the development version, clone or download the repository, navigate to the base directory, and run::
+
+    $ pip install .

docs/installation.rst

@@ -1,5 +1,8 @@
 io
 ---
 
+.. autoclass:: wfdb.io.record.Record
+    :members: adc, dac
+
 .. automodule:: wfdb.io.record
     :members: rdrecord, rdsamp, wrsamp, dl_database

docs/io.rst

@@ -0,0 +1,6 @@
+plot
+----
+
+.. automodule:: wfdb.plot.plot
+    :members: plot_record, plot_annotation, plot_all_records
+

docs/plot.rst

@@ -425,6 +425,12 @@ def plot_all_records(directory=os.getcwd()):
     """
     Plot all wfdb records in a directory (by finding header files), one at
     a time, until the 'enter' key is pressed.
+
+    Parameters
+    ----------
+    directory : str, optional
+        The directory in which to search for WFDB records.
+    
     """
     filelist = [f for f in os.listdir(directory) if os.path.isfile(os.path.join(directory, f))]
     filelist = [f for f in filelist if f.endswith('.hea')]