0
0
mirror of https://github.com/python/cpython.git synced 2024-12-01 11:15:56 +01:00
Commit Graph

20501 Commits

Author SHA1 Message Date
Ivan Levkivskyi
0705f66eb3 bpo-26213: Document _UNPACK bytecodes and BUILD_MAP changes (#238) 2017-03-03 13:46:39 -08:00
Mariatta
8eb531d9db bpo-29709: Improve Boolean Operations documentation (#433)
Change False into false, and True into true.
2017-03-03 13:16:29 -08:00
Marco Buttu
5dfccb06dc bpo-29455: Mention coverage.py in trace module documentation (#261) 2017-03-03 12:42:04 -08:00
David Ellis
85b8d01c91 bpo-29623: Make PathLike objects work with ConfigParser.read() (#242) 2017-03-03 20:14:27 +03:00
Matthias Bussonnier
c643a967dd Add Python version since deprecation in base64 methods. (#33)
Allow developers to not have to either test on N Python versions or
looked through multiple versions of the docs to know whether they can
easily update.
2017-03-02 17:21:26 +03:00
Marco Buttu
b2a7c2f986 bpo-27200: fix configparser, copyreg and ctypes doctests (#240) 2017-03-02 14:02:43 +03:00
Alex Gaynor
275104e86b In SSL module version examples, don't use a legacy version. (#381) 2017-03-02 11:23:19 +01:00
Mariatta
da62373b0d email.compat32-message.rst: Fix typo in the word message (GH-379) 2017-03-01 06:20:16 -08:00
Berker Peksag
f5184745a5 Tweak subprocess.STARTUPINFO documentation (#347)
* Document STARTUPINFO constructor
* Move versionchanged directive to above of attributes
2017-03-01 12:51:55 +03:00
Alex Gaynor
1cf2a809b1 Fixed a handful of typos (GH-343) 2017-02-28 19:26:56 -08:00
Kartik Anand
626584284e correct documentation for enum.html (#358) 2017-02-28 21:07:18 +01:00
Xiang Zhang
267b9d2fa8 bpo-7769: enable xmlrpc.server.SimpleXMLRPCDispatcher.register_function used as decorator (GH-231) 2017-02-28 17:12:52 +08:00
Berker Peksag
370f7a956c bpo-24241: Add versionchanged directive to the documentation (#342) 2017-02-27 19:13:41 +03:00
Berker Peksag
a862812565 Use "Contributed by ..." style in whatsnew/3.7.rst (#339) 2017-02-27 17:43:27 +03:00
Mariatta
091b84f23a Asyncio documentation: remove self from method signatures (GH-334) 2017-02-27 05:44:15 -08:00
INADA Naoki
f669ffff60 fix minor bug in pymalloc. (#335)
reported by Alexis Lopez-Garcia.
2017-02-27 14:42:37 +01:00
Xiang Zhang
210d6a9f95 bpo-29662: fix wrong indentation in timeit.Timer's doc (GH-332) 2017-02-27 13:42:01 +08:00
Mariatta
1f5639c77f bpo-26184: import.rst: Improve versionchanged note (GH-325) 2017-02-26 13:23:38 -08:00
Sayan Chowdhury
d5c11f7ace bpo-28624: Add a test that checks that cwd parameter of Popen() accepts PathLike objects (#157) 2017-02-26 20:06:10 +03:00
Mariatta
6b4a5f45e2 bpo-26184: import.rst: Improve versionchanged note (GH-277)
Mention that an ImportError is raised when exec_module() is defined, but
create_module() is not.
2017-02-26 07:36:57 -08:00
Berker Peksag
fe70d924bb bpo-29121: Remove outdated documentation about transactions (#313)
Patch by Aviv Palivoda.
2017-02-26 18:31:12 +03:00
Marco Buttu
ed6795e46f bpo-22594: Add a link to the regex module in re documentation (GH-241) 2017-02-26 07:26:23 -08:00
Marco Buttu
46ce7599af bpo-29648: import.rst: Add reference to create_module() (GH-290)
Add a reference to create_module(), in the first versionadded of section Loaders.
2017-02-26 07:14:45 -08:00
Jim Fasarakis-Hilliard
53c1892dc3 Fix small typos in introduction and datastructures of tutorial (GH-272)
* Fix small typos in introduction and datastructures
* Use iterable instead of L in the doc for list.extend
2017-02-25 13:13:33 -08:00
Subhendu Ghosh
ae160bba20 bpo-26128: Added __init__to subprocess.STARTUPINFO (#171)
The Windows-specific subprocess.STARTUPINFO class now accepts
keyword-only arguments to its constructor to set the various
data attributes.

Patch by Subhendu Ghosh.
2017-02-26 00:59:05 +10:00
Ratnadeep Debnath
21024f0662 bpo-16285: Update urllib quoting to RFC 3986 (#173)
* bpo-16285: Update urllib quoting to RFC 3986

urllib.parse.quote is now based on RFC 3986, and hence
includes `'~'` in the set of characters that is not escaped
by default.

Patch by Christian Theune and Ratnadeep Debnath.
2017-02-25 19:00:28 +10:00
David Steele
e3ce69522f bpo-24241: Improve preferred webbrowser handling (#85)
- Add 'preferred' argument to webbrowser.register
- Use xdg-settings to specify preferred X browser

The first change replaces the existing undocumented tri-state
'try_order' parameter with the documented boolean keyword-only
'preferred' parameter. Setting it to True places the browser at the
front of the list, preferring it as the return to a subsequent get() call.

The second change adds a private `_os_preferred_browser` setting
and then uses that to make the default browser reported by
`xdg-settings` first in the try list when running under X (or
another environment that sets the `DISPLAY` variable).
This avoids the problem where the first entry in the tryorder
queue otherwise defaults to xdg-open, which doesn't support
the "new window" option.
2017-02-25 14:47:38 +10:00
Jim Fasarakis-Hilliard
132ac381fe Fix small typos in expressions.rst (GH-276) 2017-02-24 12:32:54 -08:00
Barry Warsaw
fba79dc568 bpo-25008: Deprecate smtpd and point to aiosmtpd (#274)
* bpo-25008: Deprecate smtpd and point to aiosmtpd.

* Simplify the aiosmtpd URL.
2017-02-24 20:05:59 +01:00
Arne de Laat
324c5d8ca6 bpo-28911: Clarify the behaviour of assert_called_once_with. (#251) 2017-02-23 15:57:25 +01:00
INADA Naoki
cb41b2766d bpo-29463: Add docstring field to some AST nodes. (#46)
* bpo-29463: Add docstring field to some AST nodes.

ClassDef, ModuleDef, FunctionDef, and AsyncFunctionDef has docstring
field for now.  It was first statement of there body.

* fix document.  thanks travis!

* doc fixes
2017-02-22 16:31:59 +01:00
Matthias Bussonnier
1bc156430b bpo-29546: Improve from-import error message with location (#103)
bpo-29546: Improve from-import error message with location
2017-02-22 10:06:50 -05:00
Matthias Bussonnier
0899b98095 bpo-28814: Undeprecate inadvertently deprecated inspect functions. (#122)
Nick Coghlan said on bpo-28814:

> inspect.getargvalues() and inspect.formatargvalues() were deprecated
> in Python 3.5 as part of implementing bpo-20438

> This is incorrect, as these are *frame* introspection related functions,
> not callable introspection ones. The documentation and implementation
> layout is confusing though, as they're interleaved with the callable
> introspection operation

This commit undeprecates these functions and adds a note to ignore
previous deprecation notices.
2017-02-22 08:45:51 +03:00
INADA Naoki
fb8fe72fc5 doc: fix compile error on "shoddy" example extension (GH-215) 2017-02-21 21:51:46 +09:00
Jim Fasarakis-Hilliard
32e8f9bdfd bpo-29453: Remove reference to undefined dictionary ordering in Tutorial (GH-140)
As of Python 3.6 **kwargs are ordered, thus, remove the paragraph stating that
ordering is undefined and change snippet to remove the unecessary sorted call.

* Add sentence mentioning guaranteed output order of kwargs
2017-02-20 21:20:23 -09:00
Matthias Bussonnier
8fb1f6e039 bpo-29554: Improve docs for pstat module and profile. (#88)
Clarify that methods take a string which is interpreted as a regex,
not a regex object.

Also clarify what the old `-1`, `0`, `1` and `2` options were.
2017-02-21 08:30:00 +03:00
INADA Naoki
e395c4dbe1 bpo-29520: doc: add missing dot (GH-182)
3eea8c6 missed dot at the end of paragraph.
2017-02-20 10:22:28 +09:00
INADA Naoki
3eea8c67fa bpo-29520: doc: fix deprecation warning from 'defindex' template (GH-165) 2017-02-20 02:07:32 +09:00
Berker Peksag
d4d48743ac Tweak PEP 519 documentation in stdlib (#163)
* Drop duplicate work 'object' in lzma docs
* Fix typo in os docs: fpr -> for
2017-02-19 03:17:35 +03:00
Barry Warsaw
8c130d7f81 bpo-22807: Expose platform UUID generation safety information. (#138)
bpo-22807: Expose platform UUID generation safety information.
2017-02-18 15:45:49 -05:00
Senthil Kumaran
b2ee40ed9c Change some mercurial/ hg.python.org references. (#8) 2017-02-16 07:18:42 -08:00
Eric Appelt
23557d59b8 bpo-29026: Clarify documentation of time.time (#34)
* bpo-29026: Clarity documentation of time.time

Clarify the documentation of time.time by more
precisely defining what is meant by "seconds since
the epoch" on most platforms. Additionally explain
how gmtime and localtime may be used to extract
calendar components and convert to a more common
date format.

* bpo-29026: Minor improvements for time.time doc

* bpo-29026: Consistency fixes for time.time doc
2017-02-16 11:00:45 +01:00
Matthias Bussonnier
1d4601c2c6 bpo-29576: add explicit deprecation for importlib.abc.find_loader() and find_module() (GH-32) 2017-02-15 18:00:32 -08:00
Roger
b3f1f59cf4 Rename Doc/README.txt to Doc/README.rst and add formatting (#104)
* Reformat Doc/README.txt to Doc/README.rst

* Update mention of Doc/README.rst

* Update mention of README.txt to README.rst

* Make line fold

* rstlint ignore Doc/README.rst

* conf.py ignore Doc/README.rst

* Update issue tracker url in Docs/README.rst
2017-02-15 23:54:05 +01:00
Victor Stinner
91b0e7d0ca Doc/Makefile: set PYTHON to python3 (#124)
rstlint.py run by "make check" doesn't support Python 2.

"make venv" runs "$(PYTHON) -m venv", whereas Python 2 doens't
provide the venv module: it's a module of Python 3 standard library.
2017-02-15 23:36:08 +01:00
Mariatta
36da1c3589 bpo-29481: add versionadded 3.6.1 to typing.Deque docs (#107) 2017-02-15 11:37:18 -08:00
David Wilemski
6de2b7817f bpo-29557: Remove ambiguous line in binhex docs (#90)
"appears to not work in all cases" does not inspire confidence in this
module. I can find no context for what bug this was referencing so it
should be removed.
2017-02-15 01:37:49 +03:00
Victor Stinner
2b501866ed Travis CI: run rstlint.py in the docs job (#68)
Currently, http://buildbot.python.org/all/buildslaves/ware-docs
buildbot is only run as post-commit. For example, bpo-29521 (PR#41)
introduced two warnings, unnotified by the Travis CI docs job.

Modify the docs job to run toosl/rstlint.py.

Fix also the two minor warnings which causes the buildbot slave to
fail.
2017-02-13 15:30:05 +01:00
Jim DeLaHunt
3d707be950 bpo-29521 Fix two minor documentation build warnings (#41)
Much of bpo-29521 was fixed in parallel with commit 
e7ffb99 .  This cleans up the rest.

Apply parallel change to Doc/make.bat to read 
"set SPHINXOPTS=-D latex_elements.papersize="
I don't have a Windows system on which to observe the warning,
but it should be necessary.

The warning:

.../workspace/cpython_github/Doc/faq/windows.rst:303: 
    WARNING: unknown option: -t

In the Windows FAQ, `How do I keep editors from inserting tabs 
into my Python source?`, contained a reference to a Python -t
option. In Python 2.x, this caused Python to issue warnings
about lines with mixed spaces and tabs, but as of Python 3.6
it does nothing. 
 
Per discussion at http://bugs.python.org/issue29387, take
their wording. Python [3] raises an IndentationError or 
TabError. Tabnanny is now a module.
2017-02-13 08:57:13 -05:00
Mariatta
d4a97d8948 bpo-28929: Link the documentation to its source file on GitHub (#35)
* bpo-28929: Link the documentation to its source file on GitHub

Change the documentation's `Show Source` link on the left menu
to GitHub source file.

* change version to master
2017-02-12 13:07:05 -08:00