提案：Python文档的一个不变的URL [英] Proposal: an unchanging URL for Python documentation
问题描述
发布于：comp.lang.python
通过电子邮件发送至： do**@python.org
我有一个建议/请求，我认为会改进Python
文档。
目前， HTML格式的Python文档存储在随每个新版本的Python发生更改的URL中。也就是说，例如，os模块的
文档位于
http://python.org/doc/2.3/lib/module-os.html ，
at http://python.org/doc/2.4/lib/ module-os.html for 2.4版本等等
on。
我建议为Python HTML设置一个额外的URL
文档。此URL将始终包含
文档的当前版本。假设我们将其称为当前。然后（虽然2.4仍然是当前版本的b $ b）os模块的文档也将是
http://python.org/doc/current/lib/module-os.html 。
这个提案有三个好处。
（1）它便宜又容易。
（2）如果一个人经常提到os
模块的文档，他可以加入书签
http://python.org/doc/current/lib/module-os.html 并始终确定获得最新版本的
。
（3）这会给Pythonistas - 基本上作为免费赠品 -
可记录的文档。您可能熟悉Wikalong（
http://www.wikalong.org/）。 Wikalong基本上允许您注释
任何URL。如果我们有一个当前的Python文档的URL，人们
可以将Wikalong注释添加到当前文档中而不必担心
注释将无法在下一版本发布后继续使用
的Python。能够使用Wikalong将为Python
社区提供试验可注释文档的机会
（更不用说，乘坐Wikalong wave的前沿）。并且
那些不喜欢带注释文档的人可以很容易地忽略它，或者从Wikalong侧边栏上转过来（假设他们已经安装了Wikalong
）第一名）。
- Steve Ferg
史蒂夫>我建议为Python HTML设置一个额外的URL
steve>文档。此网址将始终包含当前版本
steve>的文件。假设我们将其称为当前。然后（虽然
史蒂夫> 2.4仍然是当前版本）os的文档
steve>模块也可以在
steve> http://python.org/doc/current/lib/ module-os.html 。
时间机在工作？上面的URL现在适用于我。
steve> （3）这将给Pythonistas - 基本上作为免费赠品 -
史蒂夫>可记录的文档。您可能熟悉Wikalong（
steve> http：// www。 wikalong.org/ ）。 Wikalong基本上允许你
史蒂夫>注释任何URL。
但似乎是特定于Firefox的。
Skip
< blockquote> [Steve]
我有一个建议/请求，我认为会改进Python
文档。
目前，HTML格式的Python文档存储在随每个新版本的Python发生变化的URL中。也就是说，例如，os模块的
文档位于
http://python.org/doc/2.3/lib/module-os.html ， http://python.org/doc/2.4/lib/module-os.html 发布2.4等等
。
你试过< http://docs.python.org> ;?
我建议为Python HTML设置一个额外的URL
文档。此URL将始终包含
文档的当前版本。假设我们将其称为当前。然后（虽然2.4仍然是当前版本）os模块的文档也将在
http://python.org/doc/current/lib/module-os.html 。
尝试
http://docs.python.org/lib/module-os.html
此提案有三个优点。
（1）它便宜又容易。
（2）如果一个人经常参考os
模块的文档，他可以加入书签
http://python.org/doc/current/lib/module-os。 HTML 并始终确保获得最新版本。
（3）这将给Pythonistas - 基本上作为免费赠品 -
可注释的文档。您可能熟悉Wikalong（
http://www.wikalong.org/）。 Wikalong基本上允许您注释任何URL。如果我们有一个当前的Python文档的URL，人们可以将Wikalong注释添加到当前文档中，而不必担心注释将无法在Python的下一个版本发布时继续存在。能够使用Wikalong将为Python
社区提供试验可注释文档的机会
（更不用说，驾驭Wikalong wave的前沿）。那些不喜欢带注释文档的人很容易忽略它，或者将它从Wikalong侧边栏上移开（假设他们首先安装了Wikalong）。
Con：它已经存在了，TOOWTDI< wink> ;.
Skip Montanaro写道：史蒂夫>我建议为Python HTML设置一个额外的URL
steve>文档。此网址将始终包含当前版本
steve>的文件。假设我们将其称为当前。然后（虽然
史蒂夫> 2.4仍然是当前版本）os的文档史蒂夫>模块也可以在
steve> http://python.org/doc/current/lib/ module-os.html 。
时间机在工作？上面的URL现在适用于我。
....
但似乎是firefox特有的。
Skip
适用于WinXP下的Firefox和IE6
Michael
posted on: comp.lang.python
emailed to: do**@python.org
I have a suggestion/request that will, I think, improve the Python
documentation.
Currently, the Python documentation in HTML format is stored at URLs
that change with each new release of Python. That is, for example, the
documentation for the os module is at
http://python.org/doc/2.3/lib/module-os.html for release 2.3 of Python,
at http://python.org/doc/2.4/lib/module-os.html for release 2.4 and so
on.
I propose that an additional a URL be set up for the Python HTML
documentation. This URL will always contain the current version of the
documentation. Suppose we call it "current". Then (while 2.4 is still
the current version) the documentation for the os module would also be
available at
http://python.org/doc/current/lib/module-os.html.
There are three advantages to this proposal.
(1) It is cheap and easy to do.
(2) If a person regularly refers to the documentation for the os
module, he can bookmark
http://python.org/doc/current/lib/module-os.html and always be sure of
getting the most current version.
(3) This would give Pythonistas -- basically as a freebie --
annotatable documentation. You may be familiar with Wikalong (
http://www.wikalong.org/ ). Wikalong basically allows you to annotate
any URL. If we had a "current" URL for Python documentation, people
could add Wikalong notes to the current documentation without worrying
that the annotations would not survive the release of the next version
of Python. Being able to use Wikalong would provide the Python
community with the opportunity to experiment with annotatable documents
(not to mention, ride the leading edge of the Wikalong wave). And
those who dislike annotated documentation can easily ignore it or turn
it off the Wikalong sidebar (assuming that they have Wikalong installed
in the first place).
-- Steve Ferg
steve> I propose that an additional a URL be set up for the Python HTML
steve> documentation. This URL will always contain the current version
steve> of the documentation. Suppose we call it "current". Then (while
steve> 2.4 is still the current version) the documentation for the os
steve> module would also be available at
steve> http://python.org/doc/current/lib/module-os.html.
Time machine at work? The above URL works for me now.
steve> (3) This would give Pythonistas -- basically as a freebie --
steve> annotatable documentation. You may be familiar with Wikalong (
steve> http://www.wikalong.org/ ). Wikalong basically allows you to
steve> annotate any URL.
But appears to be firefox-specific.
Skip
[Steve]I have a suggestion/request that will, I think, improve the Python
documentation.
Currently, the Python documentation in HTML format is stored at URLs
that change with each new release of Python. That is, for example, the
documentation for the os module is at
http://python.org/doc/2.3/lib/module-os.html for release 2.3 of Python,
at http://python.org/doc/2.4/lib/module-os.html for release 2.4 and so
on.
Have you tried <http://docs.python.org>?
I propose that an additional a URL be set up for the Python HTML
documentation. This URL will always contain the current version of the
documentation. Suppose we call it "current". Then (while 2.4 is still
the current version) the documentation for the os module would also be
available at
http://python.org/doc/current/lib/module-os.html.
Try
http://docs.python.org/lib/module-os.html
There are three advantages to this proposal.
(1) It is cheap and easy to do.
(2) If a person regularly refers to the documentation for the os
module, he can bookmark
http://python.org/doc/current/lib/module-os.html and always be sure of
getting the most current version.
(3) This would give Pythonistas -- basically as a freebie --
annotatable documentation. You may be familiar with Wikalong (
http://www.wikalong.org/ ). Wikalong basically allows you to annotate
any URL. If we had a "current" URL for Python documentation, people
could add Wikalong notes to the current documentation without worrying
that the annotations would not survive the release of the next version
of Python. Being able to use Wikalong would provide the Python
community with the opportunity to experiment with annotatable documents
(not to mention, ride the leading edge of the Wikalong wave). And
those who dislike annotated documentation can easily ignore it or turn
it off the Wikalong sidebar (assuming that they have Wikalong installed
in the first place).
Con: It''s already there, and TOOWTDI <wink>.
Skip Montanaro wrote:steve> I propose that an additional a URL be set up for the Python HTML
steve> documentation. This URL will always contain the current version
steve> of the documentation. Suppose we call it "current". Then (while
steve> 2.4 is still the current version) the documentation for the os
steve> module would also be available at
steve> http://python.org/doc/current/lib/module-os.html.
Time machine at work? The above URL works for me now.
....
But appears to be firefox-specific.
Skip
Works for me with both Firefox and IE6 under WinXP
Michael
这篇关于提案：Python文档的一个不变的URL的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
