On 4 Jun 2012, at 16:10, Barry Warsaw wrote:

> [snip...]
>>> +   However, for a structured record type use
>>> :func:`~collections.namedtuple`
>>> 
>> 
>> What's with the ~?
> 
> I'm not sure, but it seems to result in a cross-reference, and I see tildes
> used elsewhere, so I guess it's some reST/docutils magic.  I left this one in
> there.
> 


It means display the link with the text "namedtuple" instead of the full 
"collections.namedtuple". You can't just omit the "collections" as Sphinx needs 
to know where to find the link target.

Michael

> Cheers,
> -Barry
> _______________________________________________
> Python-Dev mailing list
> Python-Dev@python.org
> http://mail.python.org/mailman/listinfo/python-dev
> Unsubscribe: 
> http://mail.python.org/mailman/options/python-dev/fuzzyman%40voidspace.org.uk
> 


--
http://www.voidspace.org.uk/


May you do good and not evil
May you find forgiveness for yourself and forgive others
May you share freely, never taking more than you give.
-- the sqlite blessing 
http://www.sqlite.org/different.html





_______________________________________________
Python-Dev mailing list
Python-Dev@python.org
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: 
http://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com

Reply via email to