Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
109,764 Commits 7 Branches 587 Tags 2.3 GiB
Commit Graph

33 Commits

Author SHA1 Message Date
Antonio Cuni 315fc52db1
bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 
I think that none of these API calls can fail, but only few of them are
documented as such. Add the sentence "This function always succeeds" (which is
the same already used e.g. by PyNumber_Check) to all of them.
 2021-01-06 12:38:26 +01:00
Campbell Barton 20ce62f009
bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' (GH-22291) 2020-10-02 19:18:01 +03:00
Victor Stinner 474652fe93
bpo-40204, doc: Fix syntax of C variables (GH-21846) 
For example, fix the following Sphinx 3 errors:

Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters
Invalid C declaration: Expected identifier in nested name. [error at 5]
  void \*obj
  -----^

Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*'
Invalid C declaration: Expected end of definition. [error at 8]
  PyObject*
  --------^

The modified documentation is compatible with Sphinx 2 and Sphinx 3.
 2020-08-13 22:11:50 +02:00
Victor Stinner 59d3dce69b
bpo-40839: PyDict_GetItem() requires the GIL (GH-20580) 
Calling PyDict_GetItem() without GIL held had been allowed for
historical reason. It is no longer allowed.
 2020-06-02 14:03:25 +02:00
Zackery Spytz bb4a585d90
bpo-40428: Remove references to Py*_ClearFreeList in the docs (GH-19783) 
They were removed from the C API in commit
ae00a5a885.
 2020-04-29 04:41:56 +02:00
Joannah Nanjekye e1e80002e2
bpo-39153: Clarify C API *SetItem refcounting semantics (GH-18220) 
Some of the *SetItem methods in the C API steal a reference to the
given value. This annotates the better behaved ones to assure the
reader that these are not the ones with the inconsistent behaviour.

* 📜🤖 Added by blurb_it.

* make docs consistent with signature

Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
 2020-01-29 21:20:53 +10:00
Serhiy Storchaka 25fc088607
bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) 
Replace all *NULL* with ``NULL``.
 2019-10-30 12:03:20 +02:00
Stéphane Wirtel cbb6484573 Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 
highlightlang is deprecated since April 2018 in Sphinx.
See https://github.com/sphinx-doc/sphinx/pull/4845
 2019-05-17 15:25:34 +05:30
Sergey Fedoseev d90a141bb9 Correct name of 'defaultobj' parameter in PyDict_SetDefault() signature. (GH-11929) 2019-02-25 16:52:40 +02:00
Serhiy Storchaka 3fcc1e08db
bpo-35461: Document C API functions which suppress exceptions. (GH-11119) 2018-12-18 13:57:17 +02:00
Serhiy Storchaka 84b8e92e46 bpo-29918: Add missed "const" modifiers in C API documentation. (#846) 2017-03-30 10:01:03 +03:00
Berker Peksag e75ffa965b Add versionadded to PyDict_SetDefault documentation 
It was added for Python 3.4 in a0b750ea3397.
 2016-07-05 17:08:29 +03:00
Georg Brandl 1c669c1154 Closes #18456: Doc fix: PyDict_Update only works with dict-like objects, not key-value sequences. Patch by priyapappachan. 2014-03-25 09:34:30 +01:00
Serhiy Storchaka c679227e31 Issue #1772673: The type of `char*` arguments now changed to `const char*`. 2013-10-19 21:03:34 +03:00
Benjamin Peterson 37474f43f3 fix spelling (#17327) 2013-03-11 12:17:19 -05:00
Benjamin Peterson 285581405d say defaultobj is returned (#17327) 2013-03-11 11:50:21 -05:00
Benjamin Peterson e094833f22 remove more useless words 2013-03-11 11:35:47 -05:00
Benjamin Peterson 89fe665e38 remove useless words (#17327) 2013-03-11 11:31:29 -05:00
Ezio Melotti fc5c5320a0 Fix typo in PyDict_SetDefault docs. 2013-03-10 20:57:16 +02:00
Benjamin Peterson 00e9886bd9 Add PyDict_SetDefault. (closes #17327) 
Patch by Stefan Behnel and I.
 2013-03-07 22:16:29 -05:00
Victor Stinner 0db176f8f6 Issue #14386: Expose the dict_proxy internal type as types.MappingProxyType 2012-04-16 00:16:30 +02:00
Antoine Pitrou 9a812cbc89 Issue #13389: Full garbage collection passes now clear the freelists for 
list and dict objects.  They already cleared other freelists in the
interpreter.
 2011-11-15 00:00:12 +01:00
Benjamin Peterson 3c6830ca8f update items/keys/values doc #10300 2010-11-03 21:35:28 +00:00
Georg Brandl 2aff335c36 #9204: remove mentions of removed types in the types module. 2010-10-17 10:59:41 +00:00
Georg Brandl 60203b41b0 Migrate to Sphinx 1.0 C language constructs. 2010-10-06 10:11:56 +00:00
Victor Stinner 6009ece0ed Replace :func: by :cfunc: 
To get links to the C functions
 2010-08-17 22:01:02 +00:00
Jeroen Ruigrok van der Werven b70ccc348b After discussing some more with Georg, do no migrate versionchanged:: 2.5 to 
this branch. While I am here, also get rid of other versionchanged:: 2.x
constructs, as discussed.
 2009-04-27 08:07:12 +00:00
Jeroen Ruigrok van der Werven bd87552a34 Merged revisions 71898-71900,71910,71914-71919 via svnmerge from 
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r71898 | jeroen.ruigrok | 2009-04-25 16:24:30 +0200 (za, 25 apr 2009) | 2 lines

  Reformat prior to editing.
........
  r71899 | jeroen.ruigrok | 2009-04-25 16:27:00 +0200 (za, 25 apr 2009) | 3 lines

  The type for ppos has been Py_ssize_t since 2.5, reflect this in the
  documentation.
........
  r71900 | jeroen.ruigrok | 2009-04-25 16:28:02 +0200 (za, 25 apr 2009) | 2 lines

  Reformat paragraph.
........
  r71910 | jeroen.ruigrok | 2009-04-25 19:59:03 +0200 (za, 25 apr 2009) | 4 lines

  Issue #4129: Belatedly document which C API functions had their argument(s) or
  return type changed from int or int * to Py_ssize_t or Py_ssize_t * as this
  might cause problems on 64-bit platforms.
........
  r71914 | jeroen.ruigrok | 2009-04-25 20:31:20 +0200 (za, 25 apr 2009) | 2 lines

  Reformat prior to editing.
........
  r71915 | jeroen.ruigrok | 2009-04-25 20:46:03 +0200 (za, 25 apr 2009) | 2 lines

  Issue #4129: Document more int -> Py_ssize_t changes.
........
  r71916 | jeroen.ruigrok | 2009-04-25 20:53:48 +0200 (za, 25 apr 2009) | 2 lines

  Reformat prior to editing.
........
  r71917 | jeroen.ruigrok | 2009-04-25 20:57:32 +0200 (za, 25 apr 2009) | 2 lines

  Reference to an int type, whereas it's a Py_ssize_t as the synopsis states.
........
  r71918 | jeroen.ruigrok | 2009-04-25 21:04:15 +0200 (za, 25 apr 2009) | 2 lines

  Since I edited this file, reformat for future edits.
........
  r71919 | jeroen.ruigrok | 2009-04-25 21:10:52 +0200 (za, 25 apr 2009) | 2 lines

  Reformat prior to editing.
........
 2009-04-26 21:06:15 +00:00
Benjamin Peterson 87d98bcbad PyString_FromString -> PyUnicode_FromString 2009-03-23 21:52:09 +00:00
Alexandre Vassalotti c3e36af722 Whitespace nits. 2008-06-01 04:16:28 +00:00
Alexandre Vassalotti 787f307e35 Added documentation for PyDict_GetItemWithError(). 2008-06-01 04:00:18 +00:00
Georg Brandl e6bcc9145e Remove many "versionchanged" items that didn't use the official markup, 
but just some text embedded in the docs.

Also remove paragraph about implicit relative imports from tutorial.
 2008-05-12 18:05:20 +00:00
Georg Brandl 54a3faae08 Split C API docs in Py3k branch. 2008-01-20 09:30:57 +00:00