Georg Brandl 08be2e2f35 Add a new directive marking up implementation details and start using it.

2009-10-22 08:05:04 +00:00

..

__builtin__.rst

…

__future__.rst

#6574: list the future features in a table.

2009-09-14 14:08:54 +00:00

__main__.rst

…

_winreg.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

2to3.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

abc.rst

Fix 'the the' duplication

2009-04-03 21:45:29 +00:00

aepack.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

aetools.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

aetypes.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

aifc.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

al.rst

…

allos.rst

…

anydbm.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

archiving.rst

…

array.rst

array.array is actually a class.

2009-07-11 14:23:38 +00:00

ast.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

asynchat.rst

…

asyncore.rst

Fix for failing asyncore tests.

2009-04-01 01:28:11 +00:00

atexit.rst

…

audioop.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

autogil.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

base64.rst

#1661108: note that urlsafe encoded string can contain "=".

2009-02-13 10:56:50 +00:00

basehttpserver.rst

#1742837: expand HTTP server docs, and fix SocketServer ones to document methods as methods, not functions.

2009-04-05 10:24:20 +00:00

bastion.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

bdb.rst

Document 'skip' parameter to constructor

2009-10-05 21:25:03 +00:00

binascii.rst

…

binhex.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

bisect.rst

Move comment to correct line.

2009-06-11 22:08:10 +00:00

bsddb.rst

Minor bsddb documentation glitch

2009-03-05 19:37:37 +00:00

bz2.rst

gzip and bz2 are context managers

2009-03-09 20:38:56 +00:00

calendar.rst

…

carbon.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

cd.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

cgi.rst

Issue 6685: 'toupper' -> 'upper' in cgi doc example explanation.

2009-08-17 19:26:49 +00:00

cgihttpserver.rst

…

cgitb.rst

At least separate imports from other statements.

2009-02-20 08:22:21 +00:00

chunk.rst

…

cmath.rst

Remove leading blank line from cmath.rst

2009-07-28 16:45:13 +00:00

cmd.rst

…

code.rst

…

codecs.rst

Fix encoding name.

2009-09-22 10:55:08 +00:00

codeop.rst

Demote warnings to notices where appropriate, following the goal that as few "red box" warnings

2009-04-27 15:29:09 +00:00

collections.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

colorpicker.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

colorsys.rst

…

commands.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

compileall.rst

…

compiler.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

configparser.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

constants.rst

Remove leftover text from end of sentence.

2009-08-27 01:04:59 +00:00

contextlib.rst

Issue 6288: update the contextlib.nested() docs to explain why it has been deprecated and should generally be avoided

2009-06-17 12:12:15 +00:00

cookie.rst

…

cookielib.rst

revert r69777 since all the experts agree that extra import lines distract from the code

2009-02-20 03:31:23 +00:00

copy_reg.rst

…

copy.rst

Properly document copy and deepcopy as functions.

2009-09-09 16:49:13 +00:00

crypt.rst

Use the preferred form of raise statements in the docs.

2009-06-03 07:25:35 +00:00

crypto.rst

…

csv.rst

missing module ref (issue6723)

2009-08-18 14:37:52 +00:00

ctypes.rst

Typo fix.

2009-08-27 18:59:02 +00:00

curses.ascii.rst

…

curses.panel.rst

Remove period from end of headings.

2009-06-08 07:57:35 +00:00

curses.rst

Fix markup.

2009-10-22 07:56:02 +00:00

custominterp.rst

…

datatypes.rst

…

datetime.rst

Fix markup.

2009-10-13 18:10:59 +00:00

dbhash.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

dbm.rst

…

debug.rst

…

decimal.rst

Issue #6595: Allow Decimal constructor to accept non-European decimal

2009-08-02 10:59:36 +00:00

development.rst

…

difflib.rst

Add example to the seealso section.

2009-04-27 21:12:54 +00:00

dircache.rst

…

dis.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

distutils.rst

…

dl.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

doctest.rst

#5598: document DocFileSuite *args argument.

2009-03-31 21:15:33 +00:00

docxmlrpcserver.rst

…

dumbdbm.rst

…

dummy_thread.rst

…

dummy_threading.rst

…

easydialogs.rst

Fix markup problem.

2009-05-30 10:34:25 +00:00

email-examples.rst

#6051: refer to email examples for better way to construct email messages.

2009-05-20 18:35:27 +00:00

email.charset.rst

#5745: more linking for identifiers in email docs.

2009-04-13 13:13:25 +00:00

email.encoders.rst

#5745: more linking for identifiers in email docs.

2009-04-13 13:13:25 +00:00

email.errors.rst

#5745: more linking for identifiers in email docs.

2009-04-13 13:13:25 +00:00

email.generator.rst

#5745: more linking for identifiers in email docs.

2009-04-13 13:13:25 +00:00

email.header.rst

#5745: more linking for identifiers in email docs.

2009-04-13 13:13:25 +00:00

email.iterators.rst

…

email.message.rst

Revert inappropriate doc change.

2009-05-07 01:43:57 +00:00

email.mime.rst

#5745: more linking for identifiers in email docs.

2009-04-13 13:13:25 +00:00

email.parser.rst

#5745: more linking for identifiers in email docs.

2009-04-13 13:13:25 +00:00

email.rst

…

email.util.rst

…

errno.rst

…

exceptions.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

fcntl.rst

#6194: O_SHLOCK/O_EXLOCK are not really more platform independent than lockf().

2009-06-08 13:34:52 +00:00

filecmp.rst

#5363: fix cmpfiles() docs. Another instance where a prose description is twice as long as the code.

2009-02-27 16:39:26 +00:00

fileformats.rst

…

fileinput.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

filesys.rst

…

fl.rst

…

fm.rst

…

fnmatch.rst

improved phrasing, markup and example

2009-09-23 21:36:39 +00:00

formatter.rst

…

fpectl.rst

…

fpformat.rst

…

fractions.rst

Documentation fix for change introduced in r71832

2009-07-30 10:00:10 +00:00

framework.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

frameworks.rst

…

ftplib.rst

#6756: add some info about the "acct" parameter.

2009-09-04 11:25:37 +00:00

functions.rst

Issue #7028: Add note to hex() builtin docs pointing to float.hex().

2009-10-03 10:14:34 +00:00

functools.rst

…

future_builtins.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

gc.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

gdbm.rst

…

gensuitemodule.rst

…

getopt.rst

revert r69777 since all the experts agree that extra import lines distract from the code

2009-02-20 03:31:23 +00:00

getpass.rst

…

gettext.rst

#6593: fix link targets.

2009-07-29 16:06:31 +00:00

gl.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

glob.rst

…

grp.rst

…

gzip.rst

gzip and bz2 are context managers

2009-03-09 20:38:56 +00:00

hashlib.rst

#6908: fix association of hashlib hash attributes.

2009-09-14 14:50:47 +00:00

heapq.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

hmac.rst

…

hotshot.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

htmllib.rst

…

htmlparser.rst

…

httplib.rst

add a versionadded tag for set_tunnel

2009-05-24 18:00:13 +00:00

i18n.rst

…

ic.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

idle.rst

#5276: document IDLESTARTUP and .Idle.py.

2009-03-15 21:51:48 +00:00

imageop.rst

…

imaplib.rst

revert r69777 since all the experts agree that extra import lines distract from the code

2009-02-20 03:31:23 +00:00

imgfile.rst

…

imghdr.rst

…

imp.rst

#6448: clarify docs for find_module().

2009-07-11 10:18:10 +00:00

importlib.rst

…

imputil.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

index.rst

Add section numbering to some of the larger subdocuments.

2009-03-28 19:57:36 +00:00

inspect.rst

Typo fix.

2009-09-13 18:15:07 +00:00

internet.rst

Remove the ipaddr module per discussion on python-dev

2009-06-23 21:09:09 +00:00

intro.rst

#6486: start with built in functions rather than "built in objects".

2009-07-16 07:33:04 +00:00

io.rst

clarify buffer arg #7178

2009-10-20 21:55:17 +00:00

ipc.rst

…

itertools.rst

Add usage note.

2009-06-17 01:43:47 +00:00

jpeg.rst

…

json.rst

#5820: fix bug in usage of getreader().

2009-04-23 08:44:57 +00:00

keyword.rst

…

language.rst

…

linecache.rst

…

locale.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

logging.rst

Issue #7086: Added TCP support to SysLogHandler and tidied up some anachronisms in the code.

2009-10-10 20:32:36 +00:00

mac.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

macos.rst

Demote warnings to notices, part 2: stuff that is 2.x-only.

2009-04-27 15:29:26 +00:00

macosa.rst

…

macostools.rst

Fixed a backslash that was not supposed to be there

2009-06-30 22:56:16 +00:00

macpath.rst

…

mailbox.rst

Fix broken links found by "make linkcheck". scipy.org seems to be done right now, so I could not verify links going there.

2009-10-11 20:16:16 +00:00

mailcap.rst

…

markup.rst

…

marshal.rst

#6757: complete the list of types that marshal can serialize.

2009-09-03 12:31:39 +00:00

math.rst

Issue #3366: Add gamma function to math module.

2009-09-28 18:54:55 +00:00

md5.rst

…

mhlib.rst

…

mimetools.rst

…

mimetypes.rst

…

mimewriter.rst

…

mimify.rst

…

miniaeframe.rst

…

misc.rst

…

mm.rst

…

mmap.rst

Binary flag is needed on windows.

2009-02-28 15:24:00 +00:00

modulefinder.rst

revert r69777 since all the experts agree that extra import lines distract from the code

2009-02-20 03:31:23 +00:00

modules.rst

…

msilib.rst

Fix broken links found by "make linkcheck". scipy.org seems to be done right now, so I could not verify links going there.

2009-10-11 20:16:16 +00:00

msvcrt.rst

…

multifile.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

multiprocessing.rst

Fix issue 4660: spurious task_done errors in multiprocessing, remove doc note for from_address

2009-08-06 02:05:56 +00:00

mutex.rst

…

netdata.rst

…

netrc.rst

…

new.rst

…

nis.rst

…

nntplib.rst

…

numbers.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

numeric.rst

…

objects.rst

…

operator.rst

…

optparse.rst

Make the optparse doc style a bit more standard: use standard description units for attrs/methods/etc., and use the correct referencing roles.

2009-09-17 17:14:04 +00:00

os.path.rst

Demote warnings to notices where appropriate, following the goal that as few "red box" warnings

2009-04-27 15:29:09 +00:00

os.rst

Fix missing word.

2009-10-18 07:58:12 +00:00

ossaudiodev.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

othergui.rst

Fix broken links found by "make linkcheck". scipy.org seems to be done right now, so I could not verify links going there.

2009-10-11 20:16:16 +00:00

parser.rst

…

pdb.rst

Wording fix

2009-10-05 21:24:20 +00:00

persistence.rst

…

pickle.rst

Demote warnings to notices where appropriate, following the goal that as few "red box" warnings

2009-04-27 15:29:09 +00:00

pickletools.rst

Remove period from end of headings.

2009-06-08 07:57:35 +00:00

pipes.rst

…

pkgutil.rst

…

platform.rst

Remove period from end of headings.

2009-06-08 07:57:35 +00:00

plistlib.rst

Fix markup for external links.

2009-09-20 20:44:13 +00:00

popen2.rst

…

poplib.rst

revert r69777 since all the experts agree that extra import lines distract from the code

2009-02-20 03:31:23 +00:00

posix.rst

…

posixfile.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

pprint.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

profile.rst

…

pty.rst

platform we don't care about

2009-10-12 01:26:07 +00:00

pwd.rst

…

py_compile.rst

…

pyclbr.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

pydoc.rst

…

pyexpat.rst

…

python.rst

…

queue.rst

use property api

2009-10-20 03:14:10 +00:00

quopri.rst

…

random.rst

Issue 6261: Clarify behavior of random.uniform().

2009-06-11 23:14:53 +00:00

re.rst

#6679: Remove mention that sub supports no flags.

2009-08-13 07:48:05 +00:00

readline.rst

Issue 6877: this patch makes it possible to link the readline extension

2009-09-20 14:18:15 +00:00

repr.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

resource.rst

…

restricted.rst

…

rexec.rst

Use the preferred form of raise statements in the docs.

2009-06-03 07:25:35 +00:00

rfc822.rst

…

rlcompleter.rst

#6146: fix markup bug.

2009-05-30 07:26:04 +00:00

robotparser.rst

…

runpy.rst

Issue 4195: Restore the ability to execute packages with the -m switch (but this time in a way that leaves the import machinery in a valid state). (Original patch by Andi Vajda)

2009-02-08 01:26:34 +00:00

sched.rst

#6112: list.remove raises ValueError, not RuntimeError.

2009-05-26 07:50:23 +00:00

scrolledtext.rst

…

select.rst

Fix punctuation and one copy-paste error.

2009-08-06 17:23:21 +00:00

sets.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

sgi.rst

…

sgmllib.rst

…

sha.rst

…

shelve.rst

#6932: remove paragraph that advises relying on __del__ being called.

2009-09-17 16:15:53 +00:00

shlex.rst

…

shutil.rst

Use the preferred form of raise statements in the docs.

2009-06-03 07:25:35 +00:00

signal.rst

Fix punctuation.

2009-10-22 07:05:48 +00:00

simplehttpserver.rst

…

simplexmlrpcserver.rst

http://bugs.python.org/issue6267

2009-06-28 21:04:17 +00:00

site.rst

comment out ugly xxx

2009-09-26 02:57:59 +00:00

smtpd.rst

…

smtplib.rst

#6051: refer to email examples for better way to construct email messages.

2009-05-20 18:35:27 +00:00

sndhdr.rst

…

socket.rst

#6591: add reference to ioctl in fcntl module for platforms other than Windows.

2009-07-29 16:09:17 +00:00

socketserver.rst

#6718: fix example.

2009-08-24 17:22:05 +00:00

someos.rst

…

spwd.rst

…

sqlite3.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

ssl.rst

Rewrap long lines.

2009-09-16 15:57:46 +00:00

stat.rst

Issue 6389: add documentation for the 'mode' flags defined in the

2009-07-02 18:19:20 +00:00

statvfs.rst

…

stdtypes.rst

#7116: str.join() takes an iterable.

2009-10-14 18:48:32 +00:00

string.rst

Issue #7051: Clarify behaviour of 'g' and 'G'-style formatting.

2009-10-08 20:02:25 +00:00

stringio.rst

another cStringIO restriction

2009-07-03 14:08:20 +00:00

stringprep.rst

…

strings.rst

…

struct.rst

Fixed a typo.

2009-03-04 21:18:17 +00:00

subprocess.rst

#5329: fix os.popen* regression from 2.5: don't execute commands as a sequence

2009-09-29 19:10:15 +00:00

sun.rst

…

sunau.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

sunaudio.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

symbol.rst

…

symtable.rst

document is_declared_global()

2009-06-26 23:37:06 +00:00

sys.rst

fix typos/rephrase

2009-09-22 22:15:28 +00:00

syslog.rst

…

tabnanny.rst

Demote warnings to notices where appropriate, following the goal that as few "red box" warnings

2009-04-27 15:29:09 +00:00

tarfile.rst

Fix narkup

2009-10-05 21:24:35 +00:00

telnetlib.rst

…

tempfile.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

termios.rst

pep 8 defaults

2009-09-17 03:18:28 +00:00

test.rst

Make test.test_support.EnvironmentVarGuard behave like a dictionary.

2009-05-01 17:35:37 +00:00

textwrap.rst

…

thread.rst

#6787: reference fix.

2009-08-27 19:02:43 +00:00

threading.rst

Fix references to threading.enumerate().

2009-09-19 12:04:16 +00:00

time.rst

#5365: add quick look conversion table for different time representations.

2009-02-27 16:59:03 +00:00

timeit.rst

Fixed a wrong apostrophe

2009-06-28 00:07:45 +00:00

tix.rst

…

tk.rst

…

tkinter.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

token.rst

…

tokenize.rst

…

trace.rst

…

traceback.rst

Remove spurious 'u'.

2009-04-28 19:02:55 +00:00

ttk.rst

Add tabularcolumns directive for tables with bullet lists in them.

2009-06-16 17:41:33 +00:00

tty.rst

…

turtle.rst

Add a couple of missing function alias declarations to the turtle docs.

2009-06-25 14:21:06 +00:00

types.rst

…

undoc.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

unicodedata.rst

…

unittest.rst

#7031: Add TestCase.assertIsInstance and negated method.

2009-10-01 20:59:31 +00:00

unix.rst

…

urllib2.rst

Fix a typo.

2009-10-18 01:58:45 +00:00

urllib.rst

Fix for Issue7155 - urllib do not document default use of system proxy configuration

2009-10-18 01:24:41 +00:00

urlparse.rst

…

user.rst

…

userdict.rst

…

uu.rst

…

uuid.rst

…

warnings.rst

#6843: add link from filterwarnings to where the meaning of the arguments is covered.

2009-09-05 16:47:17 +00:00

wave.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

weakref.rst

Add a new directive marking up implementation details and start using it.

2009-10-22 08:05:04 +00:00

webbrowser.rst

#6577: fix (hopefully) all links to builtin instead of module/class-specific objects.

2009-07-26 14:19:57 +00:00

whichdb.rst

…

windows.rst

…

winsound.rst

…

wsgiref.rst

…

xdrlib.rst

…

xml.dom.minidom.rst

#6025: fix signature of parse().

2009-05-16 11:14:46 +00:00

xml.dom.pulldom.rst

…

xml.dom.rst

#5478: fix copy-paste oversight in function signature.

2009-03-15 21:47:42 +00:00

xml.etree.elementtree.rst

#6489: fix an ambiguity in getiterator() documentation.

2009-07-18 09:43:40 +00:00

xml.etree.rst

…

xml.sax.handler.rst

…

xml.sax.reader.rst

…

xml.sax.rst

…

xml.sax.utils.rst

…

xmllib.rst

…

xmlrpclib.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

zipfile.rst

Mention issue6972 in extractall docs about overwriting things outside of

2009-09-29 21:56:31 +00:00

zipimport.rst

builtin -> built-in.

2009-07-26 14:37:28 +00:00

zlib.rst

…