Python Doc Links Dead
In my Perl and Python Tutorial, i have about 50 links to documentations at python.org. For example, about 15 URL have this form: 〔http://python.org/doc/tut/node7.html〕 and about another 15 has this form: 〔http://python.org/doc/lib/typesseq-strings.html〕. As of today, all these links are 404 errors. No redirect nor any measure to tell user how to find that file.
I truely hate sites that do not take consideration of URL permanence. This has also happened to FSF. See: A Record of Frustration in IT Industry; Disappearing FSF URLs.
Link maintenance many not be easy for sites with large number of files, such as documentation. But site owners should at least be considerate of this issue. It's not too difficult to maintain permanent links. There are many solutions, such as redirects (Apache server URL rewrite, html refresh tag, file aliases), or provide dynamically generated page that tell user where the info might went.
When you create new content, you should also plan ahead on possible URL
changes. For example, if it is a documentation, you might include version number
there, for example,
example.com/latest/doc.html. This way, you can have permanent URL for
almost all your URL without much management.
So, what does this mean to you?
- As webmaster, before your create a URL, think about how the URL might impact URL permanence. Is it likely to change? Can the URL be maintained?
- As blog writer, when you link to sites, keep in mind that later all your URLs for references may be gone, and reader have no idea what's the content of those URLs. Before you link to a specific URL, you might want to include the page title, or link to a more general table of content page instead. You might be able to actively monitor your links, but you might want to make it so that your links wont suffer link rot so bad even when your site is no longer maintained (such as on a CD ROM)
2016 Addendum: Happened Again
Python Documentation Sucks
- Python Doc Problem: os.system
- Python Doc Problem: os.path.split()
- Python Doc Problem: sort()
- Python Doc Problem: gzip
- Python Documentation Problems
- Python Documentation Author Masturbation
- How to Improve Python Doc; Notes on Rewriting Python Regex Doc
- Why Python's Documentation Sucks
- Python Poetry: the __main__ Stanza
- perldoc Coming of Age, What Python Can Learn From?
- Examples of Quality Documentation in Computing Industry
- Python Doc Links Dead
- Python Doc Links All Dead
- Python = Pretentious Sheet
- Optional Function Parameters in Computer Language Docs (the idiocy thereof)
If you have a question, put $5 at patreon and message me.