897bc6f928
More minor fixes to C API docs (GH-31525)
...
* wording fixes in type.rst
* grammar and punctuation in sys.rst
* set: grammar fixes
* structures: capitalization fix
* grammar fixes for sequence
* objects: point to Py_TYPE instead of direct object access
* numbers: add more explicit Python equivalences
* method: add missing period
* memory: grammar fix
* mapping: grammar fixes
* long: grammar fix
* iter: fix grammar for PyAIter_Check
* init: grammar fix
2022-04-02 12:31:05 -07:00
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
06ca2a2be9
Fixed an incorrect sentence in the docs (GH-17205)
...
Fixed an incorrect sentence in Doc/c-api/mapping.rst I fell on
while translating the file.
skip issue
Automerge-Triggered-By: @csabella
2019-11-20 17:19:00 -08:00
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
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
3fcc1e08db
bpo-35461: Document C API functions which suppress exceptions. (GH-11119)
2018-12-18 13:57:17 +02:00
f5b1183610
bpo-5945: Improve mappings and sequences C API docs. (GH-7029)
2018-05-22 11:02:44 +03:00
0ccc0f6c74
bpo-28280: Make PyMapping_Keys(), PyMapping_Values() and PyMapping_Items() always return a list ( #3840 )
2017-10-08 11:17:46 +03:00
1d480bea9c
Issues #25909 , #28211 : Restored correct documentation of PyMapping_Items,
...
PyMapping_Keys and PyMapping_Values. Based on patch by Xiang Zhang.
2016-09-26 20:52:41 +03:00
1538b3d3df
issue25909 - Correct the documentation of PyMapping_Items, PyMapping_Keys and
...
PyMapping_Values in Include/abstract.h and Doc/c-api/mapping.rst.
Patch contributed by Sonali Gupta.
2016-01-21 09:37:28 -08:00
03863d2b29
Fixed documentation of functions with const char* arguments.
2015-06-21 17:11:21 +03:00
c679227e31
Issue #1772673 : The type of `char*` arguments now changed to `const char*`.
2013-10-19 21:03:34 +03:00
60203b41b0
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +00:00
8f7649eae4
more list()s on dictviews
2009-09-13 04:48:45 +00:00
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
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
54a3faae08
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
Jelle Zijlstra
Joannah Nanjekye
Aveheuzed
Serhiy Storchaka
Stéphane Wirtel
Oren Milman
Senthil Kumaran
Georg Brandl
Ezio Melotti
Jeroen Ruigrok van der Werven