R David Murray a198645fa0 #1753718: clarify RFC compliance and bytes/string argument types. ...

Patch includes contributions by Isobel Hooper, incorporating suggestions from
Paul Winkler.  Reviewed by Martin Panter.

In addition to accepting the corrections for the RFC compliance wording, I
went through and corrected all the argument and return types, and made the
pattern of how the arguments and return types are documented consistent.
So, this patch also addresses #20782, though I had forgotten about that issue
and its patch.

2015-12-23 21:17:17 -05:00

..

__future__.rst

…

__main__.rst

…

_dummy_thread.rst

…

_thread.rst

Issue #24952: Clarify default argument of stack_size() in threading, _thread

2015-08-31 03:15:52 +00:00

2to3.rst

Issue #25161: Add full stops in documentation; patch by Takase Arihiro

2015-10-10 10:36:22 +00:00

abc.rst

…

aifc.rst

…

allos.rst

…

archiving.rst

…

argparse.rst

Issue #25523: Further a-to-an corrections new in 3.5

2015-11-02 04:20:33 +00:00

array.rst

…

ast.rst

Fix a few grammar problems in the documentation and comments

2015-11-14 01:07:43 +00:00

asynchat.rst

…

asyncio-dev.rst

Docs and one small improvement for issue #25304, by Vincent Michel. (Merge 3.4->3.5.)

2015-10-05 16:23:13 -07:00

asyncio-eventloop.rst

Issue #25593: Change semantics of EventLoop.stop(). (Merge 3.4->3.5)

2015-11-19 13:33:34 -08:00

asyncio-eventloops.rst

Issue #25767: Merge with 3.4

2015-11-30 22:57:01 -06:00

asyncio-protocol.rst

Merge 3.4

2015-12-16 21:31:04 -05:00

asyncio-queue.rst

…

asyncio-stream.rst

docs/asyncio: Twek sections names per Nick Coghlan suggestion

2015-12-16 21:30:52 -05:00

asyncio-subprocess.rst

Use sys.platform instead of os.name to detect Windows in asyncio docs. Patch by Akira Li.

2015-11-02 09:15:47 -08:00

asyncio-sync.rst

…

asyncio-task.rst

docs/asyncio: Update ensure_future & run_coroutine_threadsafe docs

2015-12-15 00:45:24 -05:00

asyncio.rst

Make asyncio provisional

2015-08-31 11:42:31 -04:00

asyncore.rst

…

atexit.rst

…

audioop.rst

…

base64.rst

#1753718: clarify RFC compliance and bytes/string argument types.

2015-12-23 21:17:17 -05:00

bdb.rst

Issue #25161: Add full stops in documentation; patch by Takase Arihiro

2015-10-10 10:36:22 +00:00

binary.rst

…

binascii.rst

Merge: #25495: Clarify b2a_base64 documentation vis 57 bytes.

2015-12-13 18:04:56 -05:00

binhex.rst

…

bisect.rst

…

builtins.rst

…

bz2.rst

…

calendar.rst

…

cgi.rst

Issue #25176: Merge cgi.parse_qsl link from 3.4 into 3.5

2015-09-20 01:07:41 +00:00

cgitb.rst

…

chunk.rst

Issue #25523: Correct "a" article to "an" article

2015-11-02 03:37:02 +00:00

cmath.rst

…

cmd.rst

…

code.rst

…

codecs.rst

Merge 3.4 (codecs, issue #24894)

2015-09-24 09:04:26 +02:00

codeop.rst

…

collections.abc.rst

Issue #25286: Merge dictionary view glossary from 3.4 into 3.5

2015-10-07 10:01:04 +00:00

collections.rst

Issue #25700: Clarify that namedtuple property docstrings became writeable in 3.5

2015-11-23 22:18:55 -08:00

colorsys.rst

…

compileall.rst

Fixed a typo in the -b option.

2015-09-13 21:09:17 +03:00

concurrency.rst

…

concurrent.futures.rst

Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5

2015-11-02 04:04:57 +00:00

concurrent.rst

…

configparser.rst

…

constants.rst

…

contextlib.rst

Issue #25523: Merge a-to-an corrections from 3.4.

2015-11-02 14:39:05 +02:00

copy.rst

Fix a few grammar problems in the documentation and comments

2015-11-14 01:07:43 +00:00

copyreg.rst

…

crypt.rst

…

crypto.rst

…

csv.rst

Merge with 3.4

2015-09-11 10:52:36 -05:00

ctypes.rst

Issue #25523: Correct "a" article to "an" article

2015-11-02 03:37:02 +00:00

curses.ascii.rst

…

curses.panel.rst

…

curses.rst

…

custominterp.rst

…

datatypes.rst

…

datetime.rst

…

dbm.rst

…

debug.rst

…

decimal.rst

Issue #25161: Merge full stops from 3.4 into 3.5

2015-10-10 10:44:25 +00:00

depgraph-output.png

…

development.rst

…

difflib.rst

Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5

2015-11-02 04:04:57 +00:00

dis.rst

Issue #16554: fix description for MAKE_CLOSURE. Initial patch by Daniel Urban.

2015-08-13 20:37:28 +02:00

distribution.rst

…

distutils.rst

…

doctest.rst

Issue24756: clarify usage of run_docstring_examples()

2015-09-17 22:21:36 -07:00

dummy_threading.rst

…

email-examples.rst

…

email.charset.rst

Issue #25161: Add full stops in documentation; patch by Takase Arihiro

2015-10-10 10:36:22 +00:00

email.contentmanager.rst

…

email.encoders.rst

…

email.errors.rst

…

email.generator.rst

…

email.header.rst

…

email.headerregistry.rst

…

email.iterators.rst

…

email.message.rst

…

email.mime.rst

…

email.parser.rst

Issue #25523: Further a-to-an corrections.

2015-11-02 14:10:23 +02:00

email.policy.rst

…

email.rst

…

email.util.rst

…

ensurepip.rst

…

enum.rst

Close issue25594: advise against accessing Enum members from other members

2015-11-20 13:17:27 -08:00

errno.rst

…

exceptions.rst

Issue #23391: Merge OSError doc from 3.4 into 3.5

2015-10-26 23:35:07 +00:00

faulthandler.rst

…

fcntl.rst

Merge 3.4 (issue #25605)

2015-11-13 09:14:05 +01:00

filecmp.rst

…

fileformats.rst

…

fileinput.rst

…

filesys.rst

…

fnmatch.rst

…

formatter.rst

Issue #25407: Drop the mention of the formatter module being removed

2015-10-16 12:09:33 -07:00

fpectl.rst

…

fractions.rst

Issue #25161: Merge full stops from 3.4 into 3.5

2015-10-10 10:44:25 +00:00

frameworks.rst

…

ftplib.rst

Issue #11072: change the incorrect "deprecation" of ftplib dir() and nlst()

2015-12-13 22:10:28 -08:00

functional.rst

…

functions.rst

Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5

2015-11-02 04:04:57 +00:00

functools.rst

…

gc.rst

…

getopt.rst

…

getpass.rst

…

gettext.rst

…

glob.rst

Issue #25615: Merge glob doc from 3.4 into 3.5

2015-11-17 00:19:10 +00:00

grp.rst

…

gzip.rst

Issue #25523: Merge a-to-an corrections from 3.4.

2015-11-02 14:39:05 +02:00

hashlib.rst

make wikipedia link https

2015-09-27 02:05:01 -07:00

heapq.rst

…

hmac.rst

…

html.entities.rst

…

html.parser.rst

Merge: #24926: Fix typo in example.

2015-08-24 12:55:47 -04:00

html.rst

…

http.client.rst

…

http.cookiejar.rst

Issue #25523: Correct "a" article to "an" article

2015-11-02 03:37:02 +00:00

http.cookies.rst

Issue #25161: Merge full stops from 3.4 into 3.5

2015-10-10 10:44:25 +00:00

http.rst

…

http.server.rst

Issue #25523: Correct "a" article to "an" article

2015-11-02 03:37:02 +00:00

i18n.rst

…

idle.rst

Issue #24782: Finish converting the Configure Extension dialog into a new

2015-10-13 22:03:51 -04:00

imaplib.rst

…

imghdr.rst

whatsnew/3.5: Fix library news till Py3.5a1. Update other docs.

2015-09-08 22:40:30 -04:00

imp.rst

…

importlib.rst

Issue #21240: Add an abstractmethod directive to mark abstract methods in the docs more explicitly

2015-12-08 12:14:50 +02:00

index.rst

…

inspect.rst

docs/inspect: Document __annotations__

2015-10-31 13:29:15 -04:00

internet.rst

…

intro.rst

…

io.rst

Issue #22413: Merge StringIO doc from 3.4 into 3.5

2015-10-10 10:15:21 +00:00

ipaddress.rst

merge 3.4 (#24963)

2015-08-30 14:42:49 -07:00

ipc.rst

…

itertools.rst

…

json.rst

Issue #25161: Merge full stops from 3.4 into 3.5

2015-10-10 10:44:25 +00:00

keyword.rst

…

language.rst

…

linecache.rst

Fix grammar in whatsnew/3.5.rst and elsewhere

2015-11-14 01:14:54 +00:00

locale.rst

Issue #25161: Merge full stops from 3.4 into 3.5

2015-10-10 10:44:25 +00:00

logging.config.rst

…

logging.handlers.rst

Issue #25161: Merge full stops from 3.4 into 3.5

2015-10-10 10:44:25 +00:00

logging.rst

Issue #25508: Merged documentation fix from 3.4.

2015-11-24 23:22:48 +00:00

lzma.rst

…

macpath.rst

…

mailbox.rst

Issue #25523: Correct "a" article to "an" article

2015-11-02 03:37:02 +00:00

mailcap.rst

…

markup.rst

…

marshal.rst

…

math.rst

…

mimetypes.rst

…

misc.rst

…

mm.rst

…

mmap.rst

…

modulefinder.rst

Issue #25161: Add full stops in documentation; patch by Takase Arihiro

2015-10-10 10:36:22 +00:00

modules.rst

…

msilib.rst

…

msvcrt.rst

Issue #25161: Add full stops in documentation; patch by Takase Arihiro

2015-10-10 10:36:22 +00:00

multiprocessing.rst

Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5

2015-11-02 04:04:57 +00:00

netdata.rst

…

netrc.rst

…

nis.rst

…

nntplib.rst

Issue #25689: Fix language in ftplib and nntplib docs

2015-11-21 22:03:08 +00:00

numbers.rst

Issue #21240: Add an abstractmethod directive to mark abstract methods in the docs more explicitly

2015-12-08 12:14:50 +02:00

numeric.rst

…

operator.rst

…

optparse.rst

Issue #25523: Correct "a" article to "an" article

2015-11-02 03:37:02 +00:00

os.path.rst

Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5

2015-11-02 04:04:57 +00:00

os.rst

Merge 3.4 (Issue #25461)

2015-10-23 12:39:01 +02:00

ossaudiodev.rst

…

othergui.rst

…

parser.rst

…

pathlib-inheritance.png

…

pathlib-inheritance.svg

…

pathlib.rst

…

pdb.rst

Marked keystrokes with the :kbd: role.

2015-09-12 17:45:25 +03:00

persistence.rst

…

pickle.rst

Issue #25523: Merge a-to-an corrections from 3.4.

2015-11-02 14:39:05 +02:00

pickletools.rst

…

pipes.rst

…

pkgutil.rst

…

platform.rst

Issue #25161: Merge full stops from 3.4 into 3.5

2015-10-10 10:44:25 +00:00

plistlib.rst

Issue #25161: Add full stops in documentation; patch by Takase Arihiro

2015-10-10 10:36:22 +00:00

poplib.rst

…

posix.rst

…

pprint.rst

…

profile.rst

Add the original author of profile.py back to the docs, at his request.

2015-09-10 12:12:01 -07:00

pty.rst

…

pwd.rst

…

py_compile.rst

…

pyclbr.rst

…

pydoc.rst

…

pyexpat.rst

Issue #25523: Correct "a" article to "an" article

2015-11-02 03:37:02 +00:00

python.rst

…

queue.rst

…

quopri.rst

…

random.rst

…

re.rst

Merge with 3.4

2015-11-11 23:33:50 -06:00

readline.rst

Fix typo noticed by Alec Nunn

2015-11-01 00:55:12 +03:00

reprlib.rst

…

resource.rst

Issue #20468: Remove incorrect information about maxrss and page size

2015-11-17 22:13:47 +00:00

rlcompleter.rst

…

runpy.rst

Issue #14285: Do not catch exceptions initializing any ancestor package

2015-12-10 06:47:06 +00:00

sched.rst

…

select.rst

…

selectors.rst

Issue #21240: Add an abstractmethod directive to mark abstract methods in the docs more explicitly

2015-12-08 12:14:50 +02:00

shelve.rst

…

shlex.rst

…

shutil.rst

Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5

2015-11-02 04:04:57 +00:00

signal.rst

Marked keystrokes with the :kbd: role.

2015-09-12 17:46:20 +03:00

site.rst

…

smtpd.rst

…

smtplib.rst

Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5

2015-11-02 04:04:57 +00:00

sndhdr.rst

…

socket.rst

Issue #25523: Merge a-to-an corrections from 3.4.

2015-11-02 14:39:05 +02:00

socketserver.rst

…

spwd.rst

…

sqlite3.rst

Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5

2015-11-02 04:04:57 +00:00

ssl.rst

Fixed merging error in 3ebeeed1eb28.

2015-11-06 11:19:42 +02:00

stat.rst

…

statistics.rst

…

stdtypes.rst

Issue #25706: Fixed markup in the documentation.

2015-11-23 16:43:54 +02:00

string.rst

…

stringprep.rst

…

struct.rst

…

subprocess.rst

Merge: #24998: fix cut and paste error in subprocess example.

2015-09-04 10:02:27 -04:00

sunau.rst

Issue #25523: Correct "a" article to "an" article

2015-11-02 03:37:02 +00:00

superseded.rst

…

symbol.rst

…

symtable.rst

…

sys.rst

Issue #23936: Clarify what finders are.

2015-12-04 15:46:21 -08:00

sysconfig.rst

…

syslog.rst

…

tabnanny.rst

…

tarfile.rst

…

telnetlib.rst

…

tempfile.rst

Issue #25064: Adjust documentation according to new mkstemp signature

2015-11-07 00:32:50 +00:00

termios.rst

…

test.rst

Merge typo fixes from 3.4 into 3.5

2015-10-07 11:01:47 +00:00

text.rst

…

textwrap.rst

…

threading.rst

Issue #24952: Clarify default argument of stack_size() in threading, _thread

2015-08-31 03:15:52 +00:00

time.rst

…

timeit.rst

…

tk.rst

…

tkinter.rst

…

tkinter.scrolledtext.rst

…

tkinter.tix.rst

…

tkinter.ttk.rst

Issue #25161: Add full stops in documentation; patch by Takase Arihiro

2015-10-10 10:36:22 +00:00

token.rst

docs: Document ASYNC/AWAIT tokens (issue #25580)

2015-12-17 18:26:41 -05:00

tokenize.rst

Issue #25523: Further a-to-an corrections.

2015-11-02 14:10:23 +02:00

trace.rst

…

traceback.rst

…

tracemalloc.rst

Merge spelling fixes from 3.4 into 3.5

2015-10-31 12:16:18 +00:00

tty.rst

…

tulip_coro.dia

…

tulip_coro.png

…

turtle-star.pdf

…

turtle-star.png

…

turtle-star.ps

…

turtle.rst

…

types.rst

whatsnew/3.5: Another editing pass

2015-09-10 21:26:54 -04:00

typing.rst

Issue #25603: Add missing parenthesis.

2015-11-11 22:59:44 -06:00

undoc.rst

…

unicodedata.rst

…

unittest.mock-examples.rst

…

unittest.mock.rst

Issue #25523: Merge "a" to "an" fixes from 3.4 into 3.5

2015-11-02 04:04:57 +00:00

unittest.rst

Issue #25523: Merge a-to-an corrections from 3.4.

2015-11-02 14:39:05 +02:00

unix.rst

…

urllib.error.rst

…

urllib.parse.rst

Issue #25576: Merge www-form-urlencoded doc from 3.4 into 3.5

2015-11-24 22:57:46 +00:00

urllib.request.rst

Issue #22989, #21228: Merge urlopen() doc from 3.4 into 3.5

2015-11-26 11:03:50 +00:00

urllib.robotparser.rst

…

urllib.rst

…

uu.rst

…

uuid.rst

…

venv.rst

…

warnings.rst

…

wave.rst

…

weakref.rst

…

webbrowser.rst

…

windows.rst

…

winreg.rst

…

winsound.rst

…

wsgiref.rst

Issue #25161: Merge full stops from 3.4 into 3.5

2015-10-10 10:44:25 +00:00

xdrlib.rst

…

xml.dom.minidom.rst

Issue #25523: Further a-to-an corrections.

2015-11-02 14:10:23 +02:00

xml.dom.pulldom.rst

Issue #25523: Correct "a" article to "an" article

2015-11-02 03:37:02 +00:00

xml.dom.rst

Issue #25161: Add full stops in documentation; patch by Takase Arihiro

2015-10-10 10:36:22 +00:00

xml.etree.elementtree.rst

Issue #25161: Add full stops in documentation; patch by Takase Arihiro

2015-10-10 10:36:22 +00:00

xml.rst

…

xml.sax.handler.rst

…

xml.sax.reader.rst

…

xml.sax.rst

…

xml.sax.utils.rst

…

xmlrpc.client.rst

…

xmlrpc.rst

…

xmlrpc.server.rst

…

zipapp.rst

…

zipfile.rst

…

zipimport.rst

…

zlib.rst

Issue #22341: Drop Python 2 workaround and document CRC initial value

2015-12-11 05:19:29 +00:00