[SciPy-Dev] Function of the :mod: wiki function

Keith Goodman kwgoodman@gmail....
Fri Jul 9 21:41:09 CDT 2010

On Fri, Jul 9, 2010 at 6:48 PM, David Goldsmith <d.l.goldsmith@gmail.com> wrote:
> In docstrings like that for numpy.fft, which in edit mode begins:
> Discrete Fourier Transform (:mod:`numpy.fft`)
> =================================
> what's the function of the :mod:?  All it seems to do on being rendered by
> the Wiki is generate a link back to it's own document.

Yep, that's all it does. mod stands for module. So it is a link to the
numpy.fft module where the link text will be the name of the module.
You can change the link text :mod:`yourword <numpy.fft>`. Besides mod
there is func for function and meth for method and a bunch of others I
don't remember.

More information about the SciPy-Dev mailing list