Chris Jerdonek f341317185 Issue #16206: Improve the documentation of the dict constructor. ...

This change includes replacing the single-line signature documentation
with a more complete multiple-line signature.

2012-10-13 03:22:33 -07:00

..

__future__.rst

#14494: Document that absolute imports became default in 3.0 instead of 2.7.

2012-05-19 18:36:33 +03:00

__main__.rst

…

_dummy_thread.rst

…

_thread.rst

…

2to3.rst

Issue #16199: Fix typo in 2to3 docs. Thanks to Mark Lawrence for the report.

2012-10-11 15:59:32 -07:00

abc.rst

Minor wording improvement

2011-06-15 17:49:20 +02:00

aifc.rst

…

allos.rst

…

archiving.rst

Improve interlinking of archiving/compression modules docs.

2012-01-16 16:55:55 +01:00

argparse.rst

- Issue #15935: Clarification of argparse docs, re: add_argument() type and

2012-09-25 10:37:58 -04:00

array.rst

…

ast.rst

…

asynchat.rst

…

asyncore.rst

Fix closes issue 12360 - correcting parameter names in asyncore documentation.

2011-06-19 18:22:33 -07:00

atexit.rst

Improve doc for atexit.register and unregister (#12297)

2012-02-15 17:07:49 +01:00

audioop.rst

…

base64.rst

#15636: add versionadded for decodebytes

2012-08-17 20:55:21 -04:00

bdb.rst

…

binascii.rst

…

binhex.rst

…

bisect.rst

…

builtins.rst

Few typos in the documentation.

2011-11-11 19:55:21 +01:00

bz2.rst

#15543: glossary entry for and 'universal newlines', and links to it.

2012-08-15 10:43:58 -04:00

calendar.rst

…

cgi.rst

Issue11352 - Update cgi module docs

2012-04-30 22:43:13 +08:00

cgitb.rst

…

chunk.rst

…

cmath.rst

…

cmd.rst

Show the proper way to exit a cmd shell

2012-07-12 11:26:01 -07:00

code.rst

…

codecs.rst

Issue #15444: Use proper spelling for non-ASCII contributor names.

2012-08-11 16:51:50 +02:00

codeop.rst

…

collections.rst

Issue #15825: fix typo in OrderedDict docs.

2012-08-31 13:54:54 +03:00

colorsys.rst

…

compileall.rst

#10553: Explain why compileall has no command-line argument to control optimization

2011-03-26 03:22:55 +01:00

concurrent.futures.rst

Fix links to the __next__ method.

2012-10-12 13:42:08 +03:00

configparser.rst

#16085: Don't promote shadowing builtins in the configparser example.

2012-09-29 14:40:23 -04:00

constants.rst

#15429: Fix invalid mention of types.NoneType from None docs.

2012-07-22 20:43:13 -04:00

contextlib.rst

Issue #11647: allow contextmanager objects to be used as decorators as described in the docs. Initial patch by Ysj Ray.

2011-05-05 23:49:25 +10:00

copy.rst

Issue #9021 - Introduce copy module better. Doc changes suggested by Terry

2012-02-09 18:26:59 +08:00

copyreg.rst

…

crypt.rst

…

crypto.rst

update link to pycrypto (closes #12351)

2011-06-16 18:49:46 -05:00

csv.rst

#15932: use with statement in csv doc examples. Patch by Dario Bertini.

2012-09-15 05:51:45 +03:00

ctypes.rst

Add c_size_t and c_ssize_t to the ctypes summary table.

2012-07-12 20:31:50 +02:00

curses.ascii.rst

…

curses.panel.rst

…

curses.rst

#15831: document multiple signatures on different lines. Patch by Chris Jerdonek.

2012-09-14 06:32:35 +03:00

custominterp.rst

…

datatypes.rst

…

datetime.rst

issue13666 - Fixing datetime documentation example when using tzinfo

2012-06-26 20:00:15 +08:00

dbm.rst

Merge 3.1

2011-04-20 19:24:09 +02:00

debug.rst

…

decimal.rst

#13730 grammar fix

2012-01-13 23:43:13 -05:00

development.rst

…

difflib.rst

Beautify and modernize the SequenceMatcher example

2011-04-09 19:41:00 -07:00

dis.rst

Fix links to the __next__ method.

2012-10-12 13:42:08 +03:00

distutils.rst

…

doctest.rst

Issue #12947: revert earlier workaround and use a monkey-patch to enable showing doctest directives only in the doctest docs.

2012-10-10 16:45:11 +02:00

dummy_threading.rst

Issue #16174: Fix suggested usage of dummy_threading module.

2012-10-09 13:44:16 +03:00

email-examples.rst

…

email.charset.rst

#11785: fix the :mod: references in email package submodule titles.

2012-05-27 17:17:53 -04:00

email.encoders.rst

#11785: fix the :mod: references in email package submodule titles.

2012-05-27 17:17:53 -04:00

email.errors.rst

#11785: fix the :mod: references in email package submodule titles.

2012-05-27 17:17:53 -04:00

email.generator.rst

#11785: fix the :mod: references in email package submodule titles.

2012-05-27 17:17:53 -04:00

email.header.rst

#11785: fix the :mod: references in email package submodule titles.

2012-05-27 17:17:53 -04:00

email.iterators.rst

#11785: fix the :mod: references in email package submodule titles.

2012-05-27 17:17:53 -04:00

email.message.rst

#11785: fix the :mod: references in email package submodule titles.

2012-05-27 17:17:53 -04:00

email.mime.rst

#11785: fix the :mod: references in email package submodule titles.

2012-05-27 17:17:53 -04:00

email.parser.rst

#11785: fix the :mod: references in email package submodule titles.

2012-05-27 17:17:53 -04:00

email.rst

…

email.util.rst

#11785: fix the :mod: references in email package submodule titles.

2012-05-27 17:17:53 -04:00

errno.rst

…

exceptions.rst

Fix links to the __next__ method.

2012-10-12 13:42:08 +03:00

fcntl.rst

…

filecmp.rst

#15269: document dircmp.left and right, and add tests for them.

2012-08-14 21:40:13 -04:00

fileformats.rst

…

fileinput.rst

…

filesys.rst

…

fnmatch.rst

…

formatter.rst

…

fpectl.rst

…

fractions.rst

…

frameworks.rst

…

ftplib.rst

The file obj passed to ftp.storbinary/storlines must be opened in binary mode.

2012-10-05 14:09:59 +03:00

functional.rst

…

functions.rst

Issue #16206: Improve the documentation of the dict constructor.

2012-10-13 03:22:33 -07:00

functools.rst

#13852: some small doc fixes.

2012-01-25 22:36:25 +01:00

gc.rst

…

getopt.rst

Remove outdated pointer to optparse (fixes #11360).

2011-08-26 16:38:40 +02:00

getpass.rst

…

gettext.rst

Fix a typo and a broken link (part of #10536).

2011-10-07 22:02:58 +02:00

glob.rst

…

grp.rst

…

gzip.rst

Issue #13989: Document that GzipFile does not support text mode.

2012-02-11 23:45:10 +02:00

hashlib.rst

…

heapq.rst

Clean-up and improve the priority queue example in the heapq docs.

2011-10-09 17:28:14 +01:00

hmac.rst

Closes #13944: fix capitalization of class name.

2012-02-05 09:25:22 +01:00

html.entities.rst

issue10403 - Let's not use members anymore. Use 'attribute' where it denotes attribute and 'methods' where it denotes methods. Context should clarify usage.

2011-07-04 11:28:30 -07:00

html.parser.rst

#14020: improve HTMLParser documentation.

2012-02-18 02:01:36 +02:00

html.rst

Closes #14545: make clearer what was added.

2012-04-11 18:33:17 +02:00

http.client.rst

#15831: document multiple signatures on different lines. Patch by Chris Jerdonek.

2012-09-14 06:32:35 +03:00

http.cookiejar.rst

#14804: Remove [] around optional arguments with default values

2012-05-21 11:01:54 +02:00

http.cookies.rst

issue2193 - Update 3.2 docs about legal characters allowed in Cookie name

2012-04-22 10:30:17 +08:00

http.server.rst

Fix issue6085 - Remove the delay caused by fqdn lookup while logging in BaseHTTPRequestHandler

2012-04-29 13:41:03 +08:00

i18n.rst

…

idle.rst

…

imaplib.rst

Few typos in the documentation.

2011-11-11 19:55:21 +01:00

imghdr.rst

…

imp.rst

minor .rst fix

2012-04-10 19:51:00 +08:00

importlib.rst

#15543: reflow paragraphs.

2012-08-15 11:05:36 -04:00

index.rst

…

inspect.rst

Avoid using the default reST role. Makes Doc/tools/rstlint.py happy.

2011-09-01 02:47:34 +02:00

internet.rst

…

intro.rst

…

io.rst

#15694: Link discussion of file objects to glossary entry.

2012-08-17 20:33:54 -04:00

ipc.rst

…

itertools.rst

#15831: document multiple signatures on different lines. Patch by Chris Jerdonek.

2012-09-14 06:32:35 +03:00

json.rst

#11964: Document a change in v3.2 to the json indent parameter

2012-08-28 07:08:44 +03:00

keyword.rst

…

language.rst

…

linecache.rst

…

locale.rst

refer to time.strftime

2012-06-02 18:22:02 +02:00

logging.config.rst

Issue #15445: Updated logging configuration documentation to highlight potential security risk posed by listen() in certain scenarios.

2012-07-25 19:19:25 +01:00

logging.handlers.rst

Minor documentation tweak.

2012-03-26 17:09:58 +01:00

logging.rst

Issue #15399: Added versionchanged for processName.

2012-07-20 09:50:18 +01:00

macpath.rst

…

mailbox.rst

#16071: fix more email.message links in mailbox docs.

2012-09-28 15:19:16 -04:00

mailcap.rst

…

markup.rst

Move xml.etree higher and xml.parsers.expat lower in the markup ToC.

2012-03-05 16:01:41 +01:00

marshal.rst

…

math.rst

Fix markup and wording.

2011-03-31 13:59:24 -07:00

mimetypes.rst

Issue12798 - Update mimetypes documentation. Correct the doc section where

2011-12-23 10:52:42 +08:00

misc.rst

…

mm.rst

…

mmap.rst

Remove duplication.

2011-10-19 10:58:56 +03:00

modulefinder.rst

merge 11164

2011-05-09 08:10:38 +02:00

modules.rst

…

msilib.rst

…

msvcrt.rst

…

multiprocessing.rst

#15831: document multiple signatures on different lines. Patch by Chris Jerdonek.

2012-09-14 06:32:35 +03:00

netdata.rst

…

netrc.rst

…

nis.rst

#14804: Remove [] around optional arguments with default values

2012-05-21 11:01:54 +02:00

nntplib.rst

#15865: add "*" in the signature to document keyword-only args in the docs. Patch by Chris Jerdonek.

2012-09-08 20:46:01 +03:00

numbers.rst

Improve glossary entry for ABCs.

2011-06-04 18:42:38 +02:00

numeric.rst

…

operator.rst

Issue #14968: set 'Inplace Operators' as subsection; patch by Lars Buitinck

2012-06-01 20:23:20 +02:00

optparse.rst

#15831: document multiple signatures on different lines. Patch by Chris Jerdonek.

2012-09-14 06:32:35 +03:00

os.path.rst

#9921: clarify os.path.join joining algorithm

2011-06-23 21:26:13 -04:00

os.rst

#13498: Clarify docs of os.makedirs()'s exist_ok argument.

2012-10-07 18:04:38 +02:00

ossaudiodev.rst

#15831: document multiple signatures on different lines. Patch by Chris Jerdonek.

2012-09-14 06:32:35 +03:00

othergui.rst

Issue #13527: remove mention of Python megawidgets and Tkinter3000 WCK

2011-12-04 23:56:30 +01:00

parser.rst

…

pdb.rst

…

persistence.rst

…

pickle.rst

Some nits in the pickle docs.

2012-05-10 15:38:30 +02:00

pickletools.rst

…

pipes.rst

…

pkgutil.rst

…

platform.rst

Issue #15444: Use proper spelling for non-ASCII contributor names.

2012-08-11 16:51:50 +02:00

plistlib.rst

…

poplib.rst

…

posix.rst

…

pprint.rst

Merge 3.1

2011-05-29 18:07:12 +02:00

profile.rst

Merge profile docs followup (#12417) from 3.1

2011-07-28 23:00:14 +02:00

pty.rst

…

pwd.rst

…

py_compile.rst

…

pyclbr.rst

issue10403 - Let's not use members anymore. Use 'attribute' where it denotes attribute and 'methods' where it denotes methods. Context should clarify usage.

2011-07-04 11:28:30 -07:00

pydoc.rst

…

pyexpat.rst

Fix a few quotes/backslashes.

2012-09-20 09:47:03 +03:00

python.rst

…

queue.rst

Improve the grammar of a non-sentence.

2012-05-08 21:28:24 -04:00

quopri.rst

…

random.rst

#15831: document multiple signatures on different lines. Patch by Chris Jerdonek.

2012-09-14 06:32:35 +03:00

re.rst

#14519: fix the regex used in the scanf example.

2012-04-29 11:47:28 +03:00

readline.rst

Merge 3.1

2011-03-26 01:59:47 +01:00

reprlib.rst

issue10403 - Let's not use members anymore. Use 'attribute' where it denotes attribute and 'methods' where it denotes methods. Context should clarify usage.

2011-07-04 11:28:30 -07:00

resource.rst

…

rlcompleter.rst

…

runpy.rst

Issue #15230: Update runpy docs to clarify a couple of points that came up in this issue

2012-07-15 00:36:39 +10:00

sched.rst

#13278: fix typo.

2011-10-28 12:22:25 +03:00

select.rst

Restore [] where default arguments are not keywords

2012-05-22 16:12:18 +02:00

shelve.rst

…

shlex.rst

issue10403 - Let's not use members anymore. Use 'attribute' where it denotes attribute and 'methods' where it denotes methods. Context should clarify usage.

2011-07-04 11:28:30 -07:00

shutil.rst

shutil copy module reference doc fix.

2012-02-13 23:30:47 +08:00

signal.rst

Issue #14456: improve documentation of the signal module w.r.t. threads.

2012-03-31 20:56:21 +02:00

site.rst

#11643: fix rst markup error in site.rst.

2012-09-17 08:59:36 +02:00

smtpd.rst

Fix markup in smtpd.rst.

2012-09-20 09:06:51 +03:00

smtplib.rst

indicate msg is an argument

2011-12-30 23:08:09 -06:00

sndhdr.rst

…

socket.rst

#15831: document multiple signatures on different lines. Patch by Chris Jerdonek.

2012-09-14 06:32:35 +03:00

socketserver.rst

Fix Issue #6005: Examples in the socket library documentation use sendall,

2012-02-09 17:54:17 +08:00

someos.rst

…

spwd.rst

…

sqlite3.rst

Fix sqlite3 class markup.

2012-09-30 20:44:43 -04:00

ssl.rst

Update the getpeercert() example with a real-world cert showing non-trivial issuer, subject and subjectAltName.

2012-08-16 22:14:43 +02:00

stat.rst

Use attribute access instead of index access for namedtuple.

2011-08-01 22:58:53 +02:00

stdtypes.rst

Issue #16206: Improve the documentation of the dict constructor.

2012-10-13 03:22:33 -07:00

string.rst

#13579: teach string.Formatter about 'a'.

2012-08-19 17:26:34 -04:00

stringprep.rst

…

strings.rst

…

struct.rst

Fix closes Issue11436 - Minor clarification to struct documentation for 's' format character.

2011-07-17 17:29:17 +08:00

subprocess.rst

Fix placement of shell=True warning in subprocess.Popen() docs.

2012-10-10 22:52:22 -07:00

sunau.rst

…

symbol.rst

Issue #11984: remove reference to parser, it's not showing symbol usage anymore

2012-01-05 19:06:25 +01:00

symtable.rst

…

sys.rst

Fix markup errors.

2012-02-23 21:12:39 +01:00

sysconfig.rst

Fix typo (#13467)

2011-11-29 16:34:58 +01:00

syslog.rst

#15831: document multiple signatures on different lines. Patch by Chris Jerdonek.

2012-09-14 06:32:35 +03:00

tabnanny.rst

…

tarfile.rst

Improve interlinking of archiving/compression modules docs.

2012-01-16 16:55:55 +01:00

telnetlib.rst

…

tempfile.rst

#9957: document that SpooledTemporaryFile.truncate does not take size arg

2012-10-06 18:26:56 -04:00

termios.rst

…

test.rst

Issue #14554: correct example for captured_stdout(); patch by Tshepang Lekhonkhobe

2012-04-24 18:39:24 +02:00

textwrap.rst

#15510: clarify textwrap's handling of whitespace, and add confirming tests.

2012-09-08 13:13:25 -04:00

threading.rst

#14823: Simplify threading.Lock.acquire argument discussion.

2012-05-17 09:13:30 -04:00

time.rst

Fix time.time() references in the time module docs

2012-05-18 21:22:47 +03:00

timeit.rst

#15979: improve timeit documentation.

2012-10-02 05:35:39 +03:00

tk.rst

…

tkinter.rst

Issue #15041: update "see also" list in tkinter documentation.

2012-07-26 17:02:57 +03:00

tkinter.scrolledtext.rst

…

tkinter.tix.rst

#15831: document multiple signatures on different lines. Patch by Chris Jerdonek.

2012-09-14 06:32:35 +03:00

tkinter.ttk.rst

use double-quote char instead of unicode ones; thanks to tomo cocoa from docs@

2011-12-25 17:07:22 +01:00

token.rst

Issue #13632: Update token documentation to reflect actual token types

2011-12-23 22:30:16 -06:00

tokenize.rst

Issue #2134: Clarify token.OP handling rationale in tokenize documentation.

2012-01-19 00:22:22 -06:00

trace.rst

…

traceback.rst

…

tty.rst

…

turtle-star.pdf

…

turtle-star.png

…

turtle-star.ps

…

turtle.rst

document turtle done() function; thanks to Csaba Szepesvari from docs@

2011-10-31 10:12:43 +01:00

types.rst

…

undoc.rst

…

unicodedata.rst

Issue #15444: Use proper spelling for non-ASCII contributor names.

2012-08-11 16:51:50 +02:00

unittest.rst

Add missing comma.

2012-08-29 17:50:42 +03:00

unix.rst

…

urllib.error.rst

…

urllib.parse.rst

urlparse docs clean up - no reference to earlier draft

2012-06-28 21:07:58 -07:00

urllib.request.rst

Fix a bunch of "versionchanged" related markup errors.

2012-06-24 22:48:03 +02:00

urllib.robotparser.rst

…

uu.rst

…

uuid.rst

#13499: fix example adding >>> before the comments.

2011-12-02 19:28:36 +02:00

warnings.rst

Mention logging.captureWarnings in the warnings module doc.

2011-07-09 21:29:36 +02:00

wave.rst

…

weakref.rst

Issue #14954: Clarify the interaction of weak references and garbage collection.

2012-08-21 00:07:07 +02:00

webbrowser.rst

add usage example from cli; thanks to Christian Clauss from docs@

2012-08-12 17:34:00 +02:00

windows.rst

…

winreg.rst

Fix #14943. Update the proper default value and list the proper argument names in the explanation.

2012-05-29 18:34:45 -05:00

winsound.rst

…

wsgiref.rst

Issue #11968 - the start_response header values in wsgiref shoudl be str not

2011-05-11 22:34:59 +08:00

xdrlib.rst

issue10403 - Let's not use members anymore. Use 'attribute' where it denotes attribute and 'methods' where it denotes methods. Context should clarify usage.

2011-07-04 11:28:30 -07:00

xml.dom.minidom.rst

Issue #11379: add a note in xml.dom.minidom suggesting to use etree in some cases

2012-03-02 07:37:13 +02:00

xml.dom.pulldom.rst

Issue #14202: some additional doc fixes

2012-03-16 16:49:58 +02:00

xml.dom.rst

merge 11164

2011-05-09 08:10:38 +02:00

xml.etree.elementtree.rst

Issue #9257: clarify the events iterparse accepts

2012-03-16 08:41:30 +02:00

xml.sax.handler.rst

…

xml.sax.reader.rst

…

xml.sax.rst

…

xml.sax.utils.rst

…

xmlrpc.client.rst

#12787: link original MultiCall proposal to webarchive and in a footnote

2011-08-20 17:05:56 +02:00

xmlrpc.server.rst

…

zipfile.rst

Issue #16025: Minor corrections to the zipfile documentation.

2012-10-06 18:02:05 +03:00

zipimport.rst

Use correct markup in zipimport.rst. Patch by Sara Magliacane.

2011-06-25 19:40:06 +03:00

zlib.rst

Improve interlinking of archiving/compression modules docs.

2012-01-16 16:55:55 +01:00