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

[David Goldsmith]

On Sat, Jul 10, 2010 at 4:33 PM, <josef.pktd at gmail.com> wrote:

> On Sat, Jul 10, 2010 at 6:21 PM, David Goldsmith
> <d.l.goldsmith at gmail.com> wrote:
> > On Sat, Jul 10, 2010 at 2:22 PM, <josef.pktd at gmail.com> wrote:
> >>
> >> On Sat, Jul 10, 2010 at 4:38 PM, David Goldsmith
> >> <d.l.goldsmith at gmail.com> wrote:
> >> > 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.
> >>
> >> don't remove them from the package titles, I think you are destroying
> >> the module index
> >>
> >> http://docs.scipy.org/doc/scipy/reference/modindex.html
> >
> > Ah, OK, this is the info I was looking for: they do serve a
> (non-circular)
> > function I was unaware of.  Thanks, I'll leave them in; is there any way
> to
> > remove their link nature in the Wiki so that others don't make the same
> > mistake again in the future, (i.e., think that they're creating a
> redundant
> > circular reference and thus remove them)?
>
> Sorry, my mistake, I mixed up the link and the link target
> .. module::   directive indicates the module target and causes the
> entry in the module index
>
> :mod: is the link and semantic markup.
>
> I still like the full path rendering that :mod: produces in the title.
>

But it's to itself - what's the point?

DG
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20100710/948e5342/attachment.html>