84a5597b08
gh-121567: Improve `slice` C-API docs by mentioning exceptions ( #121568 )
...
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2024-07-10 13:56:44 +03:00
7c50800241
gh-110481, doc: Add "immortal" term to the glossary ( #112180 )
2023-11-17 15:09:19 +01:00
fcc816dbff
gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920)
2023-07-21 10:52:07 +03:00
a2392720d6
gh-84436: update docs on Py_None/Py_True/Py_False/Py_Ellipsis becoming immortal ( #105195 )
2023-06-21 21:13:25 +01:00
d32e8d6070
gh-105196: Fix indentations of section headings in C API docs ( #105672 )
2023-06-14 15:21:30 +01:00
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
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
4d3f084c03
bpo-27867: Add a porting guide for PySlice_GetIndicesEx(). ( #1973 )
2017-10-08 12:53:34 +03:00
2ddf5a19c3
bpo-30281: Fix the default value for stop in PySlice_Unpack() ( #1480 )
2017-05-10 18:19:41 +08:00
0dc5c3169d
bpo-30059: Include Py_Ellipsis in C API documentation ( #1018 )
2017-04-14 22:18:35 +03:00
6e08baf12d
Issue #27867 : Function PySlice_GetIndicesEx() is deprecated and replaced with
...
a macro if Py_LIMITED_API is not set or set to the value between 0x03050400
and 0x03060000 (not including) or 0x03060100 or higher. Added functions
PySlice_Unpack() and PySlice_AdjustIndices().
2017-01-25 13:27:44 +02:00
1ecf7d204d
Issue #28496 : Mark up constants 0, 1 and -1 that denote return values or
...
special input values as literal text.
2016-10-27 21:41:19 +03:00
18d378dc3d
Fix markup.
2010-12-11 22:19:34 +00:00
6d9839d011
Add versionchanged for parameter type changes.
2010-12-11 19:22:04 +00:00
dd5909725c
Adjust PySlice_GetIndices documentation to signature change.
2010-12-11 18:17:22 +00:00
2aff335c36
#9204 : remove mentions of removed types in the types module.
2010-10-17 10:59:41 +00:00
60203b41b0
Migrate to Sphinx 1.0 C language constructs.
2010-10-06 10:11:56 +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
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
54a3faae08
Split C API docs in Py3k branch.
2008-01-20 09:30:57 +00:00
sobolevn
Victor Stinner
Serhiy Storchaka
Irit Katriel
TATHAGATA ROY
Antonio Cuni
Stéphane Wirtel
Xiang Zhang
Michael Seifert
Georg Brandl
Martin v. Löwis
Jeroen Ruigrok van der Werven