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

[David Goldsmith]

On Sat, Jul 10, 2010 at 10:07 AM, Jason Grout
<jason-sage at creativetrax.com>wrote:

> On 7/9/10 6:48 PM, David Goldsmith 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.
> >
>
> For reference, here is a list of things like :mod:
>
> http://sphinx.pocoo.org/markup/inline.html
>
> (you probably already knew that, though)
>

No, I didn't thanks.  That page indicates these things are to be used for
*cross*-referencing, i.e., what we're using single backticks for; my guess
is that someone used the :mod: before all our mark-up policies were
settled.  So, I'm removing it; if someone later explains to me why it should
be there, I'll put it back in.

DG


> Jason
>
> _______________________________________________
> SciPy-Dev mailing list
> SciPy-Dev at scipy.org
> http://mail.scipy.org/mailman/listinfo/scipy-dev
>



-- 
Mathematician: noun, someone who disavows certainty when their uncertainty
set is non-empty, even if that set has measure zero.

Hope: noun, that delusive spirit which escaped Pandora's jar and, with her
lies, prevents mankind from committing a general suicide.  (As interpreted
by Robert Graves)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20100710/554033af/attachment.html>