Skip to content

Commit

Permalink
Updating the docs to correct the signature of FFTW.
Browse files Browse the repository at this point in the history
  • Loading branch information
hgomersall committed Feb 26, 2012
1 parent 48d8810 commit e68a5dd
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion _sources/index.txt
Expand Up @@ -59,7 +59,7 @@ FFTW. Simply renaming the class should be sufficient to migrate**
FFTW Class
-----------------

.. autoclass:: pyfftw.FFTW(input_array, output_array, axes=[-1], direction='FFTW_FORWARD', flags=['FFTW_MEASURE'])
.. autoclass:: pyfftw.FFTW(input_array, output_array, axes=(-1,), direction='FFTW_FORWARD', flags=('FFTW_MEASURE',))

.. _FFTW_update_arrays:

Expand Down
2 changes: 1 addition & 1 deletion index.html
Expand Up @@ -89,7 +89,7 @@ <h1>Welcome to pyFFTW&#8217;s documentation!<a class="headerlink" href="#welcome
<span id="id1"></span><h2>FFTW Class<a class="headerlink" href="#fftw-class" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="pyfftw.FFTW">
<em class="property">class </em><tt class="descclassname">pyfftw.</tt><tt class="descname">FFTW</tt><big>(</big><em>input_array, output_array, axes=[-1], direction='FFTW_FORWARD', flags=['FFTW_MEASURE']</em><big>)</big><a class="headerlink" href="#pyfftw.FFTW" title="Permalink to this definition"></a></dt>
<em class="property">class </em><tt class="descclassname">pyfftw.</tt><tt class="descname">FFTW</tt><big>(</big><em>input_array</em>, <em>output_array</em>, <em>axes=(-1</em>, <em>)</em>, <em>direction='FFTW_FORWARD'</em>, <em>flags=('FFTW_MEASURE'</em>, <em>)</em><big>)</big><a class="headerlink" href="#pyfftw.FFTW" title="Permalink to this definition"></a></dt>
<dd><p>FFTW is a class for computing the complex N-Dimensional DFT or
inverse DFT of an array using the FFTW library. The interface is
designed to be somewhat pythonic, with the correct transform being
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit e68a5dd

Please sign in to comment.