[Python-Dev] How best to handle the docs for a renamed module? (original) (raw)
Brett Cannon brett at python.org
Fri May 16 20:04:12 CEST 2008
- Previous message: [Python-Dev] How best to handle the docs for a renamed module?
- Next message: [Python-Dev] How best to handle the docs for a renamed module?
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
On Fri, May 16, 2008 at 5:43 AM, M.-A. Lemburg <mal at egenix.com> wrote:
On 2008-05-12 04:34, Brett Cannon wrote:
For the sake of argument, let's consider the Queue module. It is now named queue. For 2.6 I plan on having both Queue and queue listed in the index, with Queue deprecated with instructions to use the new name. But what to do about all the references. Should we leave them pointing at Queue to lessen confusion for people who read about some module on some other site that isn't using the new name, or update everything in 2.6 to use the new name? How hard would it be to add a redirects from the old pages to the new ones ? modrewrite does wonders - well, provided you find the right patterns...
Well, the problem is that only solves the online docs issue, not offline viewing. And now that the docs can be built easily, I at least find myself referring to the docs mostly offline rather than through docs.python.org.
-Brett
- Previous message: [Python-Dev] How best to handle the docs for a renamed module?
- Next message: [Python-Dev] How best to handle the docs for a renamed module?
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]