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

Keith Goodman kwgoodman@gmail....
Sat Jul 10 08:51:42 CDT 2010

On Sat, Jul 10, 2010 at 2:00 AM, David Goldsmith
<d.l.goldsmith@gmail.com> wrote:
> On Fri, Jul 9, 2010 at 7:41 PM, Keith Goodman <kwgoodman@gmail.com> wrote:
>> 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>`.
> Ah, that's what I was missing; still, what's the point of having a circular
> reference, even by another name, or is it only a circular reference in the
> Wiki 'cause the docstring is all the Wiki pulls for any object?

Oh, I didn't realize about the circular part. Yeah, that seems odd.
Doesn't add anything.

More information about the SciPy-Dev mailing list