Windson yang
98b8535415
bpo-35118: Improve docs regarding indexing (GH-10265)
2018-11-04 14:34:22 -08:00
Stéphane Wirtel
55f3317e98
bpo-10536: Enhancements to gettext docs (GH-10324)
2018-11-04 23:24:41 +01:00
Saptak Sengupta
622935d9a6
bpo-31887: Adds documentations for special multipart/signed handling (GH-4268)
...
This pull request adds some information about the special multipart/signed handling to clear about disabling header folding.
https://bugs.python.org/issue31887
2018-11-04 14:12:34 -08:00
Adrian Liaw
c03bf0ae79
Doc: Disable smartquotes for zh-tw, zh-cn, fr and ja translations (GH-9423)
2018-11-04 22:04:51 +01:00
Stéphane Wirtel
0edc7b1b1a
bpo-35159: Add a link to the devguide in the sidebar of the index (Doc/) (GH-10316)
2018-11-04 21:41:34 +01:00
Elena Oat
52465e1b8b
Explain that the orderness of the result of glob is system-dependant (GH-6587)
...
Thanks!
2018-11-04 15:50:55 +01:00
Julien Palard
f98c1623ec
Doc: -W flag for sphinx-build can be disabled (GH-10303)
2018-11-03 19:06:33 +01:00
Stéphane Wirtel
3e28eed9ec
bpo-34969: Add --fast, --best on the gzip CLI (GH-9833)
2018-11-03 16:24:23 +01:00
İsmail Arılık
fe62d877e3
Fix a typo about a comma. (GH-10306)
2018-11-03 17:05:59 +02:00
Pablo Galindo
bf46a09dec
bpo-35075: Fix broken url in the pprint documentation (GH-10201)
...
https://bugs.python.org/issue35075
2018-11-01 05:29:38 -07:00
Serhiy Storchaka
511747bec3
bpo-35110: Fix yet few spaces before dashes. (GH-10255)
2018-10-31 11:14:38 +02:00
Serhiy Storchaka
3f819ca138
bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231)
2018-10-31 02:26:06 +02:00
matthewbelisle-wf
68f323715e
bpo-35116, urllib.parse: Document the new max_num_fields parameter (GH-10247)
2018-10-30 21:30:19 +01:00
Daniel Lovell
a80af77087
bpo-35086: Fix tkinter example "A Simple Hello World Program". (GH-10160)
...
The root widget was accessed as a global variable in the Application's method.
2018-10-30 16:56:07 +02:00
Serhiy Storchaka
b232df9197
bpo-31680: Add curses.ncurses_version. (GH-4217)
...
Use curses.ncurses_version for conditionally skipping a test.
2018-10-30 13:22:42 +02:00
Andriy Maletsky
b83d917faf
Doc: fix asyncio loop.close() description (GH-10229)
...
Needs backport to 3.7. In 3.6 the description is correct.
2018-10-29 14:39:21 -07:00
Stephan Hoyer
0200928e8d
Include memo in the documented signature of copy.deepcopy()
...
* Include memo in the documented signature of copy.deepcopy()
The memo argument is mentioned lower on the doc page under writing a
`__deepcopy__` method, but is not included in the documented function signature.
This makes it easy to miss, and can lead to incorrect/buggy implementations of
`__deepcopy__` -- which is exatly what just happpend to me!
2018-10-29 12:30:12 -06:00
Gus Goulart
c0799ec973
bpo-27741: Better wording for datetime.strptime() (GH-9994)
2018-10-29 12:49:52 +01:00
Terry Jan Reedy
ea9c8bd443
bpo-35097: Add IDLE doc subsection explaining editor windows. ( #10206 )
...
Topics include opening, title and status bar, .py* extension, and running.
2018-10-28 20:42:18 -04:00
Pablo Galindo
c61e229d2a
bpo-33234: Add exact allocation optimization to lists in What's New (GH-10200)
...
In commit 372d705
a new optimization to the list() type was introduced but it was not added
to the optimization section in What's new for Python 3.8.
2018-10-28 22:03:18 +00:00
Terry Jan Reedy
18032632ab
Issue 35093: Document the IDLE document viewer in the IDLE doc. ( #10195 )
...
Add a paragraph in "Help and preferences", "Help sources" subsection.
2018-10-28 16:21:18 -04:00
Raymond Hettinger
e3685fd5fd
bpo-34160: Preserve user specified order of Element attributes (GH-10163)
2018-10-28 11:18:22 -07:00
Terry Jan Reedy
68d6dc0770
bpo-1529353: Explain Shell text squeezing in the IDLE doc. ( #10169 )
2018-10-28 12:44:44 -04:00
Sebastian Rittau
c8a8d6b347
bpo-35089: Don't mention typing.io and typing.re (GH-10173)
...
https://bugs.python.org/issue35089
2018-10-28 16:03:29 +00:00
Serhiy Storchaka
913876d824
bpo-35054: Add yet more index entries for symbols. (GH-10121)
2018-10-28 13:41:26 +02:00
Andrés Delfino
95f68b10d5
Fix mistakes on function coroutines related definitions (GH-9871)
...
Fix a bug I introduced in #9864 by which coroutines are treated as synonymous of function coroutines.
Also, fix the same mistake (coroutines == function coroutines) already present in other parts of the reference.
I'm very sorry for the hassle.
2018-10-28 03:41:57 -07:00
Andreas Pelme
d855f2fdbd
unittest documentation: Spell pytest without the dot (GH-9820)
...
Referring to ``pytest`` as ``py.test`` is deprecated.
2018-10-27 11:09:12 -07:00
nsrip
40bf6cff22
Fix typo in zipfile documentation. (GH-10151)
2018-10-27 17:42:56 +03:00
Serhiy Storchaka
fec35c99aa
bpo-33710: Deprecate l*gettext() and related functions in the gettext module. (GH-10139)
...
They return encoded bytes and are Python 2 artifacts.
2018-10-27 08:00:41 +03:00
Terry Jan Reedy
d9bff4e81b
bpo-35079: Revise difflib.SequenceManager.get_matching_blocks doc (GH-10144)
...
Specify that blocks are non-overlapping. Change '!=' to '<'.
2018-10-26 23:03:08 -04:00
Stéphane Wirtel
12e696b4f0
bpo-35042: Use the :pep: role where a PEP is specified ( #10036 )
2018-10-26 15:58:26 -07:00
Benjamin Peterson
4e3a53bcee
Fix a typo in asyncio-dev.rst. (GH-10133)
...
"threadsafe"
2018-10-26 10:14:04 -07:00
Andrés Delfino
a6dc531063
bpo-34789: make xml.sax.make_parser accept iterables of all types (GH-9576)
2018-10-26 17:56:57 +03:00
Senthil Kumaran
25a525bf5a
Simplify the warning for http.server. ( #10116 )
2018-10-26 06:43:37 -07:00
Pablo Galindo
7cd2543416
bpo-34890: Make iscoroutinefunction, isgeneratorfunction and isasyncgenfunction work with functools.partial (GH-9903)
...
inspect.isfunction() processes both inspect.isfunction(func) and
inspect.isfunction(partial(func, arg)) correctly but some other functions in the
inspect module (iscoroutinefunction, isgeneratorfunction and isasyncgenfunction)
lack this functionality. This commits adds a new check in the mentioned functions
in the inspect module so they can work correctly with arbitrarily nested partial
functions.
2018-10-26 12:19:14 +01:00
Stéphane Wirtel
e483f02423
bpo-35044, doc: Use the :exc: role for the exceptions (GH-10037)
2018-10-26 12:52:11 +02:00
Serhiy Storchaka
ddb961d2ab
bpo-35054: Add more index entries for symbols. (GH-10064)
2018-10-26 09:00:49 +03:00
Max Bélanger
6c83d9f4a7
bpo-35022: unittest.mock.MagicMock now also supports __fspath__ (GH-9960)
...
The MagicMock class supports many magic methods, but not __fspath__. To ease
testing with modules such as os.path, this function is now supported by default.
2018-10-25 23:48:58 +02:00
Stéphane Wirtel
1770d1c512
bpo-35038: AttributeError: 'frame' object has no attribute 'f_restricted'. (GH-10098)
...
https://bugs.python.org/issue35038
2018-10-25 14:13:45 -07:00
Stéphane Wirtel
9e95eb0d60
Fix grammar in using/unix build instruction docs (GH-10009)
2018-10-25 10:32:30 -05:00
Ned Batchelder
890423f796
configparser doc: Properly label ConfigParser attributes (GH-9930)
2018-10-25 01:47:01 +02:00
orlnub123
78401f7156
importlib doc: Fix approximated import_module() code (GH-9945)
...
The spec gets stored on modules with the __spec__ attribute, not spec.
2018-10-25 01:32:26 +02:00
TilmanK
e80e77a484
bpo-35027, distutils doc: Correct note on setup.py change in Python 3.7 (GH-10032)
2018-10-25 00:50:25 +02:00
Mariatta
9f43fbbd9d
Use f-strings in asyncio-task code examples (GH-10035)
...
Replace str.format with f-strings in the code examples of asyncio-task documentation.
2018-10-25 00:37:12 +02:00
jdemeyer
057f4078b0
bpo-32797: improve documentation of linecache.getline (GH-9540)
2018-10-24 14:44:41 +02:00
Tal Einat
dfba1f67e7
bpo-33899: Mention tokenize behavior change in What's New (GH-10073)
2018-10-24 00:20:05 -07:00
Zsolt Cserna
4f399be0e7
bpo-34260, shutil: fix copy2 and copystat documentation (GH-8523)
...
Fix the documentation of copy2, as it does not copy file ownership (user and
group), only mode, mtime, atime and flags.
The original text was confusing to developers as it suggested that this
command is the same as 'cp -p', but according to cp(1), '-p' copies file
ownership as well.
Clarify which metadata is copied by shutil.copystat in its docstring.
2018-10-23 12:09:50 +02:00
Andrei Petre
83a07652e0
bpo-34748: link to :ref:`partial-objects` in functools.partial doc. (GH-9809)
2018-10-23 14:11:20 +08:00
Xtreak
121eb1694c
bpo-34081: Fix wrong example link that was linking to distutils (GH-8248)
2018-10-21 16:54:52 +02:00
Xtreak
c3f52a59ce
bpo-35036: Remove empty log line in the suspicious.py tool (GH-10024)
...
Previous to commit ee171a2
the logline was working because of self.info() (now
deprecated) defaults to an empty message.
2018-10-21 13:57:32 +01:00
Benjamin Peterson
12d0ff1230
Remove ">>>" from testsetup. (GH-10017)
...
Fixes doc build breakage from 890a4b9293
.
2018-10-20 16:51:05 -07:00
Xtreak
890a4b9293
bpo-35020: Link to sorting examples from list.sort() (GH-9931)
2018-10-20 14:39:03 -07:00
Senthil Kumaran
eeab510bb7
bpo-34576 - Fix the formatting for security considerations in http.server.rst ( #10005 )
...
* bpo-34576 - Fix the formatting for security considerations in http.server.rst
* Address review comment.
2018-10-20 11:32:07 -07:00
Stéphane Wirtel
d262250d07
bpo-35032: Remove inaccessible videos from faq/Windows (GH-10004)
...
https://bugs.python.org/issue35032
2018-10-20 08:27:03 -07:00
Stéphane Wirtel
0522fd81dc
bpo-34839: Add a 'before 3.6' in the section 'warnings' of doctest (GH-9736)
2018-10-20 10:43:32 +02:00
Pablo Galindo
d5b4f1b5a0
bpo-34983: Expose symtable.Symbol.is_nonlocal() in the symtable module (GH-9872)
...
The symbol table was not exposing functionality to query the nonlocal symbols
in a function or to check if a particular symbol is nonlocal.
2018-10-20 01:46:00 +01:00
Pablo Galindo
027664a3d5
bpo-32798: Add restriction on the offset parameter for mmap.flush in the docs ( #5621 )
...
Add restriction on the offset parameter for mmap.flush.
Explain that ALLOCATIONGRANULARITY is the same as PAGESIZE in Unix.
2018-10-20 02:37:55 +02:00
Berker Peksag
13ae4d4438
bpo-21196: Clarify name mangling rules in tutorial (GH-5667)
...
Initial patch by Chandan Kumar.
2018-10-20 02:33:48 +02:00
Alexey Izbyshev
a2670565d8
bpo-32236: open() emits RuntimeWarning if buffering=1 for binary mode (GH-4842)
...
If buffering=1 is specified for open() in binary mode, it is silently
treated as buffering=-1 (i.e., the default buffer size).
Coupled with the fact that line buffering is always supported in Python 2,
such behavior caused several issues (e.g., bpo-10344, bpo-21332).
Warn that line buffering is not supported if open() is called with
binary mode and buffering=1.
2018-10-20 02:22:31 +02:00
Andrés Delfino
0f14fc1a7c
bpo-33726, doc: Add short descriptions to PEP references in seealso (GH-7294)
2018-10-20 01:31:15 +02:00
Julien Palard
acef69068f
queue doc: Clarify that the simple FIFO queue is SimpleQueue (GH-8372)
2018-10-20 00:27:49 +02:00
Mario Corchero
96200eb2ff
unittest.mock doc: Fix references to recursive seal of Mocks (GH-9028)
...
The docs in `library/unittest.mock` have been updated to remove
confusing terms about submock and be explicit about the behavior
expected.
2018-10-19 23:57:37 +02:00
Serhiy Storchaka
b2e2025941
bpo-33073: Rework int.as_integer_ratio() implementation (GH-9303)
...
* Simplify the C code.
* Simplify tests and make them more strict and robust.
* Add references in the documentation.
2018-10-19 23:46:31 +02:00
Sergey Fedoseev
b981fec8d6
Use dict unpacking in functools.partial() docs (GH-9412)
2018-10-19 23:42:07 +02:00
Serhiy Storchaka
6543912c90
bpo-32912: Replace a DeprecationWarning with a SyntaxWarning (GH-9652)
...
for invalid escape sequences in string and bytes literals.
2018-10-19 17:42:06 +03:00
Braden Groom
5be00247ae
bpo-26441: Remove documentation for deleted to_splittable and from_splittable methods ( #9865 )
2018-10-18 20:13:23 -04:00
Vinay Sajip
bbd90e4f62
Updated documentation on logging.debug(). (GH-9946)
2018-10-18 11:45:58 +01:00
Cheryl Sabella
0f11a88622
Add missing comma to wsgiref doc (GH-9932)
2018-10-17 22:55:32 +01:00
Julien Palard
8e73ad38ab
Doc: Fix is_prime (GH-9909)
2018-10-17 08:45:51 +02:00
Cheryl Sabella
c984d20ec8
In email docs, correct spelling of foregoing ( #9856 )
2018-10-16 15:28:34 -04:00
Cheryl Sabella
a5ca98537b
In email.parser in message_from_bytes, update `strict` to `policy` ( #9854 )
...
According to the versionchanged note, the `strict` argument was removed in 3.3 and `policy` was added, but the name of the argument in the paragraph wasn't updated.
2018-10-16 15:26:17 -04:00
Vinay Sajip
1a4a10d9f1
Added CLI starter example to logging cookbook. (GH-9910)
2018-10-16 12:36:52 +01:00
Braden Groom
43a5bd7b45
bpo-23554: Change echo server example class name from EchoServerClientProtocol to EchoServerProtocol (GH-9859)
2018-10-15 17:39:16 -04:00
Pablo Galindo
ee171a26c1
Stop using deprecated logging API in Sphinx suspicious checker (GH-9875)
2018-10-15 20:07:23 +01:00
Wolfgang Maier
6bdb6f7675
fix dangling keyfunc examples in documentation of heapq and sorted ( #1432 )
...
* fix dangling mention of key=str.lower in heapq doc
* Fix dangling mention of keyfunc example for sorted()
2018-10-15 13:06:53 -06:00
BNMetrics
18fb1fb943
bpo-34844: logging.Formatter enhancement - Ensure style and format string matches in logging.Formatter (GH-9703)
2018-10-15 19:41:36 +01:00
Andrés Delfino
c8bb467f40
Update compound_stmts.rst ( #9864 )
2018-10-14 11:18:16 +03:00
Zackery Spytz
0461704060
bpo-22872: multiprocessing.Queue's put() and get() now raise ValueError if the queue is closed. (GH-9010)
...
Previously, put() and get() would raise AssertionError and OSError,
respectively.
2018-10-13 12:26:09 +03:00
Stéphane Wirtel
e385d0661e
bpo-34967: Sphinx is deprecating add_description_unit, use add_object_type (GH-9827)
2018-10-13 08:14:08 +02:00
Juliette Monsel
bf034715db
bpo-23831: Add moveto method to the tkinter.Canvas widget. (GH-9768)
2018-10-12 19:44:10 +03:00
Cheryl Sabella
2d6097d027
bpo-11233: Create availability directive for documentation (GH-9692)
...
Replace "Availability: xxx" with ".. availability:: xxx" in the doc.
Original patch by Georg Brandl.
Co-Authored-By: Georg Brandl <georg@python.org>
2018-10-12 16:55:20 +02:00
Gus Goulart
4505f65ae7
bpo-34203: FAQ now recommends python 3.x over 2.x (GH-9796)
2018-10-12 12:16:43 +03:00
Stéphane Wirtel
859c068e52
bpo-34962: make doctest in Doc/ now passes, and is enforced in CI (GH-9806)
2018-10-12 09:51:05 +02:00
Felipe Rodrigues
1d26c72e6a
bpo-34576 warn users on security for http.server ( #9720 )
...
It was proposed to add an warning for http.server regarding security
issues. The wording was provided at bpo-26005 by @orsenthil
2018-10-10 19:43:40 -07:00
Elvis Pranskevichus
a6b3ec5b6d
bpo-34022: Stop forcing of hash-based invalidation with SOURCE_DATE_EPOCH (GH-9607)
...
Unconditional forcing of ``CHECKED_HASH`` invalidation was introduced in
3.7.0 in bpo-29708. The change is bad, as it unconditionally overrides
*invalidation_mode*, even if it was passed as an explicit argument to
``py_compile.compile()`` or ``compileall``. An environment variable
should *never* override an explicit argument to a library function.
That change leads to multiple test failures if the ``SOURCE_DATE_EPOCH``
environment variable is set.
This changes ``py_compile.compile()`` to only look at
``SOURCE_DATE_EPOCH`` if no explicit *invalidation_mode* was specified.
I also made various relevant tests run with explicit control over the
value of ``SOURCE_DATE_EPOCH``.
While looking at this, I noticed that ``zipimport`` does not work
with hash-based .pycs _at all_, though I left the fixes for
subsequent commits.
2018-10-10 18:43:14 +02:00
Mayank Asthana
7e18deef65
bpo-34926: Make mimetypes.guess_type accept os.PathLike objects (GH-9777)
...
:meth:`mimetypes.MimeTypes.guess_type` now accepts :term:`path-like object` in addition to url strings.
2018-10-10 16:46:44 +02:00
Stéphane Wirtel
7c817e620b
bpo-34913: Document gzip command line interface (GH-9782)
2018-10-10 08:28:26 +02:00
animalize
6261ae9b01
bpo-32174: Let .chm document display non-ASCII characters properly (GH-9758)
...
Let .chm document display non-ASCII characters properly
Escape the `body` part of .chm source file to 7-bit ASCII, to fix visual effect on some MBCS Windows systems.
2018-10-08 14:20:54 -07:00
Paul Bailey
4c33997057
bpo-34911: Added support for secure websocket cookies (GH-9734)
2018-10-08 21:49:29 +03:00
Juliette Monsel
af5658ae93
bpo-34829: Add missing selection_ methods to the Tkinter Spinbox. (GH-9617)
...
Implement the methods selection_from(), selection_range(), selection_present()
and selection_to() for Tkinter Spinbox.
2018-10-08 19:29:24 +03:00
Xtreak
a8d5e2f255
Use double quote instead of backtick to clarify Ellipsis constant (GH-9754)
2018-10-08 20:44:16 +05:30
Sanyam Khurana
ffc5a14d00
bpo-33014: Clarify str.isidentifier docstring (GH-6088)
...
* bpo-33014: Clarify str.isidentifier docstring
* bpo-33014: Add code example in isidentifier documentation
2018-10-08 12:23:32 +05:30
Danish Prakash
656d52dbfd
bpo-34901: add isolated (-I) flag to sys.flags (GH-9708)
...
https://bugs.python.org/issue34901
2018-10-07 09:12:31 -07:00
Andrés Delfino
7dfbd49671
Correct grammar mistake in re.rst. (GH-9745)
2018-10-06 22:48:30 +03:00
Stéphane Wirtel
683281f536
bpo-34906: Doc: Fix typos (2) (GH-9735)
...
Fix typos
2018-10-06 16:35:53 +02:00
Christophe Nanteuil
92878829c3
bpo-34158: Documentation UTC offset update (GH-8377)
...
* Documentation of UTC offset update
Since changes in the UTC offset that allows sub-minute offsets, the documentation needs update:
- "%z" format code documentation update
Karthikeyan Singaravelan commented on bugs.python.org:
Added as part of 018d353c1c
and a fix regarding duplicate words for that part was added at bac2d5ba30
.
Relevant format string at https://github.com/python/cpython/pull/2896/files#diff-25e2d173c84057d069b7890450714eddR214 .
Relevant test case with 6-digit string for microsecond : https://github.com/python/cpython/pull/2896/files#diff-acc40bec51c7de832de3361db3edae52R309 .
Table at https://docs.python.org/3.7/library/datetime.html#strftime-and-strptime-behavior could also be updated with microseconds being optional in the second column
%z | UTC offset in the form ±HHMM[SS] (empty string if the object is naive). | (empty), +0000, -0400, +1030
- isoformat documentation update
According to me, needs confirmation:
Relevant format string at https://github.com/python/cpython/pull/4699/files#diff-25e2d173c84057d069b7890450714eddR176
Relevant test case at https://github.com/python/cpython/pull/4699/files#diff-25e2d173c84057d069b7890450714edd
* From Martin Panter: some style improvment;
From @pganssle: using f for fractional part of seconds in all file.
2018-10-05 18:57:02 -04:00
Xtreak
6f9c55d1c0
bpo-34825: Add more entries to os to pathlib reference table (GH-9608)
...
The added functions are as below :
| os module | Pathlib |
| ------------- | ------------- |
| os.chmod | Path.chmod |
| os.mkdir | Path.mkdir |
| os.rename | Path.rename |
| os.replace | Path.replace |
| os.rmdir | Path.rmdir |
| os.remove, os.unlink | Path.unlink |
| os.path.samefile | Path.samefile |
Thanks
https://bugs.python.org/issue34825
2018-10-05 08:24:11 -07:00
Stéphane Wirtel
07fbbfde1b
bpo-34906: Doc: Fix typos (GH-9712)
2018-10-05 16:17:18 +02:00
Benjamin Peterson
e006b39a40
Make it clear that the msg argument to assertWarns/assertWarnsRegex/assertRaisesRegex is keyword-only. (GH-9680)
...
A follow up to be4e5b8920
.
2018-10-02 21:38:39 -07:00
Cheryl Sabella
11c4eaa993
Remove recent from logging cookbook (GH-9636)
2018-10-02 09:35:05 -07:00