[Python-ideas] docs.python.org: Short URLs

Markus Unterwaditzer markus at unterwaditzer.net
Mon Feb 17 21:54:09 CET 2014


On Mon, Feb 17, 2014 at 12:25:03PM -0500, random832 at fastmail.us wrote:
> On Mon, Feb 17, 2014, at 11:40, Ryan Hiebert wrote:
> > Yeah, that would be a better place to redirect for 'str'.
> > 
> > I was just pointing that I'm not sure what these URLs really gain us,
> > if they aren't meant to be used as the canonical URLs, since the
> > #identified
> > URLs are perfectly useful as permalinks. Does having these redirects make
> > it easier to find these things using a search engine? If not, we gain
> > some
> > neat URLs that are still only useful to those of us that actually already
> > know
> > the documentation anyway.
> 
> I don't know why they should be redirects, no. I think what's being
> proposed in the article _was_ a separate page for every class and every
> function. PHP does that. .NET does that. Why shouldn't Python? Is it
> possible that the Python documentation suffers from excessive
> conciseness _because_ everything's on one page?
> _______________________________________________
> Python-ideas mailing list
> Python-ideas at python.org
> https://mail.python.org/mailman/listinfo/python-ideas
> Code of Conduct: http://python.org/psf/codeofconduct/

I agree, it would be a better idea to have short and meaningful URLs, but as
far as i know, this would require major modifications to Sphinx (unless you're
actually creating an RST page for every object) and would require significantly
more effort than the change i am suggesting.

In my original mail i didn't even consider the SEO-aspect of short URLs, i just
remembered from my PHP days that typing php.net/function_name was very helpful
once i've discovered i can do that.

-- Markus


More information about the Python-ideas mailing list