[docs] [issue11643] Use |version| instead of X.Y in the doc

Éric Araujo report at bugs.python.org
Mon Mar 28 00:49:39 CEST 2011


Éric Araujo <merwok at netwok.org> added the comment:

Yes, this was literal.  grep result on 3.1:

c-api/intro.rst:73:path and then use ``#include <pythonX.Y/Python.h>``; this will break on
c-api/intro.rst:534:directory named :file:`lib/python{X.Y}` relative to the parent directory
c-api/intro.rst:540::file:`/usr/local/lib/python{X.Y}`.  (In fact, this particular path is also
faq/general.rst:356:titled "Python X.Y Release Schedule", where X.Y is a version that hasn't been
howto/urllib2.rst:156:``Python-urllib/x.y`` (where ``x`` and ``y`` are the major and minor version
install/index.rst:240:| Unix (pure)     | :file:`{prefix}/lib/python{X.Y}/site-packages`      | :file:`/usr/local/lib/python{X.Y}/site-packages` | \(1)  |
install/index.rst:242:| Unix (non-pure) | :file:`{exec-prefix}/lib/python{X.Y}/site-packages` | :file:`/usr/local/lib/python{X.Y}/site-packages` | \(1)  |
install/index.rst:265:Windows, choose :menuselection:`Start --> Programs --> Python X.Y -->
install/index.rst:386:| pure module distribution     | :file:`{prefix}/lib/python{X.Y}/site-packages`      | :option:`--install-purelib` |
install/index.rst:388:| non-pure module distribution | :file:`{exec-prefix}/lib/python{X.Y}/site-packages` | :option:`--install-platlib` |
install/index.rst:634:the search path will be set to ``['', '/www/python/lib/pythonX.Y/',
install/index.rst:635:'/www/python/lib/pythonX.Y/plat-linux2', ...]``.
library/site.rst:42::file:`/usr/local`.  The Python X.Y library is then installed in
library/site.rst:43::file:`/usr/local/lib/python{X.Y}` (where only the first three characters of
library/site.rst:45:a subdirectory :file:`/usr/local/lib/python{X.Y}/site-packages` with three
library/site.rst:65:   /usr/local/lib/pythonX.Y/site-packages/bar
library/site.rst:66:   /usr/local/lib/pythonX.Y/site-packages/foo
library/pydoc.rst:67:``http://docs.python.org/X.Y/library/`` where ``X`` and ``Y`` are the
library/logging.rst:442:found for logger X.Y.Z" is printed to the console. This message is intended
library/logging.rst:464:done using loggers with names matching "foo.x.y", then the code::
library/stdtypes.rst:2324:'/usr/local/lib/pythonX.Y/os.pyc'>``.

There are also things like “python2.3”:
extending/building.rst:97:   gcc -DNDEBUG -g -O3 -Wall -Wstrict-prototypes -fPIC -DMAJOR_VERSION=1 -DMINOR_VERSION=0 -I/usr/local/include -I/usr/local/include/python2.2 -c demo.c -o build/temp.linux-i686-2.2/demo.o
faq/extending.rst:240::file:`/usr/lib/python2.{x}/config/` directory, which contains various files
faq/general.rst:500:   python2.2 <pathto>/db2pickley.py database.db database.pck
install/index.rst:362:them to go in :file:`/usr/local/lib/python2.{X}` rather than
install/index.rst:363::file:`/usr/lib/python2.{X}`.  This can be done with ::
install/index.rst:370:modules in :file:`/usr/local/lib/python2.{X}`, but those modules would have to
install/index.rst:371:be installed to, say, :file:`/mnt/{@server}/export/lib/python2.{X}`.  This could
install/index.rst:590:   ['', '/usr/local/lib/python2.3', '/usr/local/lib/python2.3/plat-linux2',
install/index.rst:591:    '/usr/local/lib/python2.3/lib-tk', '/usr/local/lib/python2.3/lib-dynload',
install/index.rst:592:    '/usr/local/lib/python2.3/site-packages']
install/index.rst:703:   :file:`{prefix}/lib/python1.5/site-packages/distutils`, so the system
library/sysconfig.rst:243:            platlib = "/usr/local/lib/python3.2/site-packages"
library/sysconfig.rst:244:            platstdlib = "/usr/local/lib/python3.2"
library/sysconfig.rst:245:            purelib = "/usr/local/lib/python3.2/site-packages"
library/sysconfig.rst:247:            stdlib = "/usr/local/lib/python3.2"
library/re.rst:1115:     File "/usr/local/lib/python3.2/re.py", line 132, in match
tutorial/interpreter.rst:13:The Python interpreter is usually installed as :file:`/usr/local/bin/python3.2`
tutorial/interpreter.rst:17:   python3.2
tutorial/interpreter.rst:97:   $ python3.2
tutorial/interpreter.rst:151:   #! /usr/bin/env python3.2

(Please ignore distutils and install docs, they’re frozen except for bugfixes, there’s no value in working on them with the replacement coming Really Soon Now™.)

Do docs people agree this automation would be something useful?

FYI: https://pypi.python.org/pypi/grin/1.2.1

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue11643>
_______________________________________


More information about the docs mailing list