Commit Graph

216 Commits

Author SHA1 Message Date
Berker Peksag af51140fa0 Fix typo and silence a Sphinx warning in Doc/glossary.rst 2016-06-11 22:40:41 +03:00
Serhiy Storchaka f41b82fb19 Issue #26282: PyArg_ParseTupleAndKeywords() and Argument Clinic now support
positional-only and keyword parameters in the same function.
2016-06-09 16:30:29 +03:00
Yury Selivanov a6f6edbda8 Issue #27243: Fix __aiter__ protocol 2016-06-09 15:08:31 -04:00
Martin Panter 46f50726a0 Issue #27076: Doc, comment and tests spelling fixes
Most fixes to Doc/ and Lib/ directories by Ville Skyttä.
2016-05-26 05:35:26 +00:00
Senthil Kumaran 3858a1c18c Issue23675 - A tiny clarification in the MRO glossary term. 2016-01-09 22:33:54 -08:00
Brett Cannon ccddbb186b Issue #23936: Clarify what finders are.
Thanks to Raúl Cumplido for the bug report and Thomas Kluyver for the
patch.
2015-12-04 15:46:21 -08:00
Martin Panter 84835ab1cb Issue #25161: Merge full stops from 3.4 into 3.5 2015-10-10 10:44:25 +00:00
Martin Panter d21e0b52f1 Issue #25161: Add full stops in documentation; patch by Takase Arihiro 2015-10-10 10:36:22 +00:00
Martin Panter 446977c080 Issue #25286: Merge dictionary view glossary from 3.4 into 3.5 2015-10-07 10:01:04 +00:00
Martin Panter 85b8f45515 Issue #25286: Dictionary views are not sequences
Also change glossary heading from view
2015-10-07 09:56:46 +00:00
Stefan Krah 70e543b266 Issue #23756: Clarify the terms "contiguous" and "bytes-like object".
Patch by Martin Panter.
2015-08-08 14:33:28 +02:00
Yury Selivanov 66f8828bfc Issue #24439: Improve PEP 492 related docs.
Patch by Martin Panter.
2015-06-24 11:04:15 -04:00
Yury Selivanov 5376ba9630 Issue #24400: Introduce a distinct type for 'async def' coroutines.
Summary of changes:

1. Coroutines now have a distinct, separate from generators
   type at the C level: PyGen_Type, and a new typedef PyCoroObject.
   PyCoroObject shares the initial segment of struct layout with
   PyGenObject, making it possible to reuse existing generators
   machinery.  The new type is exposed as 'types.CoroutineType'.

   As a consequence of having a new type, CO_GENERATOR flag is
   no longer applied to coroutines.

2. Having a separate type for coroutines made it possible to add
   an __await__ method to the type.  Although it is not used by the
   interpreter (see details on that below), it makes coroutines
   naturally (without using __instancecheck__) conform to
   collections.abc.Coroutine and collections.abc.Awaitable ABCs.

   [The __instancecheck__ is still used for generator-based
   coroutines, as we don't want to add __await__ for generators.]

3. Add new opcode: GET_YIELD_FROM_ITER.  The opcode is needed to
   allow passing native coroutines to the YIELD_FROM opcode.

   Before this change, 'yield from o' expression was compiled to:

      (o)
      GET_ITER
      LOAD_CONST
      YIELD_FROM

   Now, we use GET_YIELD_FROM_ITER instead of GET_ITER.

   The reason for adding a new opcode is that GET_ITER is used
   in some contexts (such as 'for .. in' loops) where passing
   a coroutine object is invalid.

4. Add two new introspection functions to the inspec module:
   getcoroutinestate(c) and getcoroutinelocals(c).

5. inspect.iscoroutine(o) is updated to test if 'o' is a native
   coroutine object.  Before this commit it used abc.Coroutine,
   and it was requested to update inspect.isgenerator(o) to use
   abc.Generator; it was decided, however, that inspect functions
   should really be tailored for checking for native types.

6. sys.set_coroutine_wrapper(w) API is updated to work with only
   native coroutines.  Since types.coroutine decorator supports
   any type of callables now, it would be confusing that it does
   not work for all types of coroutines.

7. Exceptions logic in generators C implementation was updated
   to raise clearer messages for coroutines:

   Before: TypeError("generator raised StopIteration")
   After: TypeError("coroutine raised StopIteration")
2015-06-22 12:19:30 -04:00
Yury Selivanov a18cad543f Issue 24180: Fixes by Berker Peksag. 2015-05-21 17:02:31 -04:00
Yury Selivanov f3e40fac10 Issue 24180: Documentation for PEP 492 changes. 2015-05-21 11:50:30 -04:00
Larry Hastings ab792ac704 Doc clarification / edification on the semantics of the 'w*' format unit. 2015-04-13 11:30:56 -04:00
Georg Brandl 0443c92ee1 merge with 3.4 2015-01-15 08:16:25 +01:00
Georg Brandl caa12dab69 Closes #23244: fix typo. Thanks Mayank Tripathi for the patch. 2015-01-15 08:16:01 +01:00
Nick Coghlan 582acb75e9 Merge issue 19548 changes from 3.4 2015-01-07 00:37:01 +10:00
Nick Coghlan b9fdb7a452 Issue 19548: update codecs module documentation
- clarified the distinction between text encodings and other codecs
- clarified relationship with builtin open and the io module
- consolidated documentation of error handlers into one section
- clarified type constraints of some behaviours
- added tests for some of the new statements in the docs
2015-01-07 00:22:00 +10:00
Antoine Pitrou 5db1bb81ff Issue #22696: Add function :func:`sys.is_finalizing` to know about interpreter shutdown. 2014-12-07 01:28:27 +01:00
Georg Brandl cadc3fdcb5 Merge with 3.4 2014-10-29 08:37:29 +01:00
Georg Brandl e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Georg Brandl 033ec051f8 merge with 3.4 2014-10-06 16:48:38 +02:00
Georg Brandl 4dd27a3edb Closes #21782: the default hash(x) is not exactly id(x) but derived from it. 2014-10-06 16:45:23 +02:00
Nick Coghlan 4a4b679515 Merge issue #22295 fix from 3.4 2014-09-06 20:40:00 +10:00
Nick Coghlan 1d52096d14 Issue #22295: Adopt 'python -m pip' as the preferred invocation 2014-09-06 20:38:23 +10:00
Terry Jan Reedy 8d2d8894da Merge with 3.4 2014-08-23 18:29:02 -04:00
Terry Jan Reedy 004e87048a Issue #22232 (partial fix): update Universal newlines Glossary entry. 2014-08-23 18:28:44 -04:00
Raymond Hettinger 35db43955c Issue #13742: Add key and reverse parameters to heapq.merge() 2014-05-30 02:28:36 -07:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Andrew Kuchling a3d0ffe2c6 Merge from 3.3 2014-02-15 17:22:41 -05:00
Andrew Kuchling cb3ff4468a #16728: Mention collections.abc.Sequence in 'sequence' glossary entry 2014-02-15 17:05:26 -05:00
Eric Snow ca2d854df8 Issue #19713: Update importlib docs for module spec changes, including deprecations. 2013-12-16 23:06:52 -07:00
Antoine Pitrou 710280b6d6 Issue #18840: Introduce the json module in the tutorial, and deemphasize the pickle module. 2013-12-05 23:48:10 +01:00
Antoine Pitrou dd799d2e32 Issue #18840: Introduce the json module in the tutorial, and deemphasize the pickle module. 2013-12-05 23:46:32 +01:00
Zachary Ware e19e3f0b91 Issue #18326: merge with 3.3 2013-11-22 14:03:10 -06:00
Zachary Ware e1391a0d68 Issue #18326: Clarify that list.sort's arguments are keyword-only.
Also, attempt to reduce confusion in the glossary by not saying there are
different "types" of arguments and parameters.
2013-11-22 13:58:34 -06:00
Nick Coghlan 4dae27a08d Tweak 'provisional' in glossary 2013-10-20 13:22:04 +10:00
Serhiy Storchaka 0d85b5c68d Issue #19190: Improve cross-references in builtin types and functions documentation. 2013-10-09 14:03:24 +03:00
Serhiy Storchaka 0d196edc37 Issue #19190: Improve cross-references in builtin types and functions documentation. 2013-10-09 14:02:31 +03:00
Georg Brandl 245c765d0a merge with 3.3 2013-10-08 08:06:27 +02:00
Georg Brandl bcce1256e3 Closes #19178: some more cross-references about packages in glossary. Patch by Berker Peksag. 2013-10-08 08:06:18 +02:00
Georg Brandl 7e41547c47 merge with 3.3 2013-10-06 11:57:23 +02:00
Georg Brandl 60e602dcc6 Fix small grammar mistake. 2013-10-06 11:57:13 +02:00
Łukasz Langa fdcf2b7d4e moved the single-dispatch generic function definitions to the glossary 2013-06-07 22:54:03 +02:00
R David Murray 25cd09115d #14187: Add glossary entry for 'function annotations'.
Patch by Chris Rebert.
2013-05-06 12:58:16 -04:00
Antoine Pitrou 5de183a07c Elaborate on bytes-like objects. 2013-05-04 20:18:34 +02:00
Ezio Melotti aa54e2ff5e #16518: add "bytes-like object" to the glossary. 2013-04-30 23:33:31 +03:00
Ezio Melotti 84ad6aea73 #16128: merge with 3.2. 2013-02-01 05:20:06 +02:00
Ezio Melotti 188ad851fb #16128: clarify that instances of user-defined classes compare equal with themselves. 2013-02-01 05:18:44 +02:00
Ezio Melotti 407c2ac4f7 #16747: merge with 3.2. 2013-01-02 22:29:41 +02:00
Ezio Melotti d581fff6f0 #16747: fix link to file objects in the glossary. 2013-01-02 22:29:09 +02:00
Chris Jerdonek 32bbc1c396 Merge from 3.2: add links and index entries for "argument" and "parameter."
This adds to the work done for issue #15990 (i.e. f44b8d69e5fc and the
commits referenced there).
2012-12-25 14:57:54 -08:00
Chris Jerdonek b43099464a Add additional links and index entries for "argument" and "parameter".
This adds to the work done for issue #15990 (i.e. f44b8d69e5fc and the
commits referenced there).
2012-12-25 14:54:44 -08:00
Chris Jerdonek d97c71feda Merge from 3.2: improve argument/parameter documentation (issue #15990). 2012-11-28 02:37:42 -08:00
Chris Jerdonek c2a7fd60e1 Improve argument/parameter documentation (issue #15990).
This commit adds "parameter" to the glossary, improves and consolidates the
"argument" glossary entry, and adds a question to the FAQ on the difference
between arguments and parameters.
2012-11-28 02:29:33 -08:00
Benjamin Peterson 143d034ecd merge 3.2 2012-10-12 12:04:32 -04:00
Ezio Melotti 7fa822275b Fix links to the __next__ method. 2012-10-12 13:42:08 +03:00
Andrew Svetlov fd03a099d8 Merge issue #16138: fix typo. 2012-10-05 13:26:42 +03:00
Andrew Svetlov 8cf1cc498f Issue #16138: fix typo. 2012-10-05 13:26:10 +03:00
Nick Coghlan 1685db011d s/path importer/path based finder/ (because the path based finder is not an importer and the simpler 'path finder' is too ambiguous) 2012-08-20 13:49:08 +10:00
R David Murray 27bbcfb8ff Merge #15543: glossary entry for and 'universal newlines', and links to it.
Patch by Chris Jerdonek.
2012-08-15 11:11:27 -04:00
R David Murray 1b00f25bf9 #15543: glossary entry for and 'universal newlines', and links to it.
Patch by Chris Jerdonek.
2012-08-15 10:43:58 -04:00
Barry Warsaw dadebab42c Finally, a coherent set of terminology for all the lil' beasties involved. 2012-07-31 16:03:09 -04:00
Barry Warsaw c1e721b979 Address substantially all of Eric Snow's comments in issue #15295, except for
those which now have additional XXX's here.  I'll get to those later. :)
2012-07-30 16:24:12 -04:00
Barry Warsaw d7d2194ea1 Integration of importdocs from the features/pep-420 repo. 2012-07-29 16:36:17 -04:00
Sandro Tosi 7f671338de backport c4bd68be5fc6 to 3.2 2012-06-02 23:41:19 +02:00
Sandro Tosi 5b072efc28 merge with 3.2 2012-04-01 01:50:22 +02:00
Sandro Tosi 165a2c2e27 fix typo; thanks to Robert Bardos from docs@ 2012-04-01 01:50:00 +02:00
Eli Bendersky dbaedb8cf9 fix typo in glossary 2012-03-30 11:02:05 +03:00
Eli Bendersky 6bdb650ab2 Added the "provisional package" glossary term from PEP 411 2012-03-30 10:52:25 +03:00
Senthil Kumaran 9186850088 closes issue14257 - Grammatical fix 2012-03-12 10:05:58 -07:00
Senthil Kumaran 6080db7606 closes issue14257 - Grammatical fix 2012-03-12 10:05:34 -07:00
Senthil Kumaran 68e994e9e4 closes issue14257 - cpython - minor error in glossary wording regarding __hash__ 2012-03-11 21:06:03 -07:00
Senthil Kumaran a7fccd8b14 closes issue14257 - 3.2 minor error in glossary wording regarding __hash__ 2012-03-11 21:04:56 -07:00
Antoine Pitrou 86a36b500a PEP 3155 / issue #13448: Qualified name for classes and functions. 2011-11-25 18:56:07 +01:00
Florent Xicluna f8240d6564 Merge 3.2, doc typos. 2011-11-11 19:58:53 +01:00
Éric Araujo b8edbdf4b9 Merge doc changes from 3.2.
rstlint complains about packaging docs but I’m working on those in
another patch.
2011-09-01 05:57:12 +02:00
Éric Araujo 7af8ebb6ce Adapt/remove mentions of functions gone in 3.x 2011-09-01 03:20:13 +02:00
Éric Araujo d1ca4f9dc6 Merge fixes for #12256 and typos from 3.2 2011-08-19 09:36:59 +02:00
Éric Araujo 04ac59a22a Mention virtual subclasses in the glossary entry for ABCs (#12256).
I added a link from the term “virtual subclass” to the glossary entry
for ABCs but this was not enough, now the glossary briefly defines
“virtual” and links to the abc module doc which contains more mentions
of virtual subclasses.
2011-08-19 09:07:46 +02:00
Éric Araujo 24d6cc6f4f Merge 3.2 2011-08-19 03:19:36 +02:00
Éric Araujo 0519b09936 Avoid splitting a word between a link and text 2011-08-19 00:39:19 +02:00
Éric Araujo 2527796a22 Merge from 3.2 (#10318, #12255, #12043, #12417 and other fixes) 2011-07-29 03:11:09 +02:00
Éric Araujo 7c12bae717 Fix reST references 2011-07-26 15:14:35 +02:00
Éric Araujo 459b452b98 Merge ABC and distutils touch-ups from 3.2.
I have removed the reST target I added in 38cdca2cc253: it is not necessary, as
people can link to the glossary entry or the abc module without it.

Two indentation fixes from 3.2 collections.rst have been ported to 3.3
collections.abc.rst.
2011-06-04 21:16:42 +02:00
Éric Araujo fa088dbd0c Improve glossary entry for ABCs.
- Rename reST target name for collections ABCs to avoid collisions
- Add link to importlib ABCs (collections, numbers and io ABCs were already
  linked)
- Link to glossary entry from numbers module doc (other modules already do it)
2011-06-04 18:42:38 +02:00
Éric Araujo 601aba6f15 Merge touch-ups and fixes for #9831 (+port fix to packaging) and #9223 from 3.2 2011-05-29 00:56:39 +02:00
Éric Araujo c5069e0070 Merge doc touch-ups and fixes for #9831 and #9223 from 3.1 2011-05-29 00:29:56 +02:00
Éric Araujo e0854f9dbf Add missing closing paren 2011-05-27 04:36:52 +02:00
Benjamin Peterson 82f614b20a glossary entry for struct sequence 2011-04-20 18:27:32 -05:00
Georg Brandl d98934c483 Merged revisions 87101,87146,87156,87172,87175,87371,87378,87522-87524,87526-87528,87530-87536,87581 via svnmerge from
svn+ssh://svn.python.org/python/branches/py3k

........
  r87101 | georg.brandl | 2010-12-06 23:02:48 +0100 (Mo, 06 Dez 2010) | 1 line

  Remove visible XXX comments.
........
  r87146 | georg.brandl | 2010-12-09 19:08:43 +0100 (Do, 09 Dez 2010) | 1 line

  Fix "seperate".
........
  r87156 | georg.brandl | 2010-12-10 11:01:44 +0100 (Fr, 10 Dez 2010) | 1 line

  #10668: fix wrong call of __init__.
........
  r87172 | georg.brandl | 2010-12-11 20:10:30 +0100 (Sa, 11 Dez 2010) | 1 line

  Avoid AttributeError(_closed) when a TemporaryDirectory is deallocated whose mkdtemp call failed.
........
  r87175 | georg.brandl | 2010-12-11 23:19:34 +0100 (Sa, 11 Dez 2010) | 1 line

  Fix markup.
........
  r87371 | georg.brandl | 2010-12-18 17:21:58 +0100 (Sa, 18 Dez 2010) | 1 line

  Fix typo.
........
  r87378 | georg.brandl | 2010-12-18 18:51:28 +0100 (Sa, 18 Dez 2010) | 1 line

  #10723: add missing builtin exceptions.
........
  r87522 | georg.brandl | 2010-12-28 10:16:12 +0100 (Di, 28 Dez 2010) | 1 line

  Replace sys.maxint mention by sys.maxsize.
........
  r87523 | georg.brandl | 2010-12-28 10:18:24 +0100 (Di, 28 Dez 2010) | 1 line

  Remove confusing paragraph -- this is relevant only to advanced users anyway and does not belong into the tutorial.
........
  r87524 | georg.brandl | 2010-12-28 10:29:19 +0100 (Di, 28 Dez 2010) | 1 line

  Fix advice: call PyType_Ready to fill in ob_type of custom types.
........
  r87526 | georg.brandl | 2010-12-28 11:38:33 +0100 (Di, 28 Dez 2010) | 1 line

  #10777: fix iteration over dict keys while mutating the dict.
........
  r87527 | georg.brandl | 2010-12-28 11:56:20 +0100 (Di, 28 Dez 2010) | 1 line

  #10768: fix ScrolledText widget construction, and make the example work from the interactive shell.
........
  r87528 | georg.brandl | 2010-12-28 12:02:12 +0100 (Di, 28 Dez 2010) | 1 line

  Add news entry and clarify another.
........
  r87530 | georg.brandl | 2010-12-28 12:06:07 +0100 (Di, 28 Dez 2010) | 1 line

  #10767: update README in crashers; not all may have a bug entry and/or be fixed.
........
  r87531 | georg.brandl | 2010-12-28 12:08:17 +0100 (Di, 28 Dez 2010) | 1 line

  #10742: document readonly attribute of memoryviews.
........
  r87532 | georg.brandl | 2010-12-28 12:15:49 +0100 (Di, 28 Dez 2010) | 1 line

  #10781: clarify that *encoding* is not a parameter for Node objects in general.
........
  r87533 | georg.brandl | 2010-12-28 12:38:12 +0100 (Di, 28 Dez 2010) | 1 line

  Remove history; adapt a bit more to reST, since this will once be part of the dev guide.
........
  r87534 | georg.brandl | 2010-12-28 12:48:53 +0100 (Di, 28 Dez 2010) | 1 line

  Rewrap.
........
  r87535 | georg.brandl | 2010-12-28 12:49:41 +0100 (Di, 28 Dez 2010) | 1 line

  #10739: document that on Windows, socket.makefile() does not make a file that has a true file descriptor usable where such a thing is expected.
........
  r87536 | georg.brandl | 2010-12-28 12:53:25 +0100 (Di, 28 Dez 2010) | 1 line

  #10609: fix non-working dbm example.
........
  r87581 | georg.brandl | 2010-12-30 18:36:17 +0100 (Do, 30 Dez 2010) | 1 line

  Fix NameErrors.
........
2011-02-25 10:03:34 +00:00
Georg Brandl 41d0815a65 Merged revisions 87789-87790 via svnmerge from
svn+ssh://svn.python.org/python/branches/py3k

........
  r87789 | georg.brandl | 2011-01-06 10:23:56 +0100 (Do, 06 Jan 2011) | 1 line

  Fix various issues (mostly Python 2 relics) found by Jacques Ducasse.
........
  r87790 | georg.brandl | 2011-01-06 10:25:27 +0100 (Do, 06 Jan 2011) | 1 line

  Add acks where acks are due.
........
2011-01-09 08:01:46 +00:00
Raymond Hettinger e3ee66f141 Issue #10357: Clarify what it means to be a mapping. 2011-01-08 23:44:37 +00:00
Antoine Pitrou 6e7d711d2a Merged revisions 87792 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k

........
  r87792 | antoine.pitrou | 2011-01-06 17:31:28 +0100 (jeu., 06 janv. 2011) | 3 lines

  Elaborate about the GIL.
........
2011-01-06 16:34:50 +00:00
Antoine Pitrou 003428158b Elaborate about the GIL. 2011-01-06 16:31:28 +00:00
Georg Brandl b30f3303f7 Fix various issues (mostly Python 2 relics) found by Jacques Ducasse. 2011-01-06 09:23:56 +00:00
Georg Brandl 9d9848e776 Rewrap. 2010-12-28 11:48:53 +00:00
Raymond Hettinger 09f44140aa Expand the LBYL glossary entry. 2010-12-17 20:19:50 +00:00