Skip to content

Commit 4587d33

Browse files
rwgkhenryiii
andauthored
docs: prepare for v3.0.0rc1 (#5589)
* Squashed prepv300/manuscript — 30b9c26 — 2025-03-30 14:56:03 -0700 [skip ci] [Browse prepv300/manuscript tree](https://github.com/rwgk/pybind11/tree/30b9c268aeb98308ea42aaccfd5fe454e173c6fc) [Browse prepv300/manuscript commits](https://github.com/rwgk/pybind11/commits/30b9c268aeb98308ea42aaccfd5fe454e173c6fc/) * docs: update changelog Signed-off-by: Henry Schreiner <[email protected]> * docs: upgrade guide CMake suggestions Signed-off-by: Henry Schreiner <[email protected]> * Explain type_caster_enum_type_enabled, copyable_holder_caster_shared_ptr_with_smart_holder_support_enabled, move_only_holder_caster_unique_ptr_with_smart_holder_support_enabled in Upgrade guide. * Add a small section for py::bind_vector, py::bind_map & py::smart_holder * Fix tiny oversight: Reference back to the current release v2.13 (not v2.12) * Remove sentence: Using self._pybind11_conduit_v1_() ... should keep extension compatibility. This isn't true, because we also modernized `PYBIND11_PLATFORM_ABI_ID` (which I believe was absolutely necessary). I think it'll be too complicated to explain that here, and there is a mention in the Upgrade guide. * Changelog: combine #4953 and #5439 * Trivial whitespace/formatting fixes/enhancements. * chore: add more to deprecation page Signed-off-by: Henry Schreiner <[email protected]> * docs: update for recent additions Signed-off-by: Henry Schreiner <[email protected]> * docs: fixes and set rc1 version Signed-off-by: Henry Schreiner <[email protected]> * fix: support rc versions Signed-off-by: Henry Schreiner <[email protected]> * Undo erroneous copilot change: We need to use `detail::enable_if_t`, for compatibility with C++11 and C++14. * Empty lines cleanup. * Rewording of "CMake support now defaults to ..." paragraph. * Add missing backticks in upgrade guide. * Try :ref:deprecated instead of :doc:deprecated * docs: last bit of polish Signed-off-by: Henry Schreiner <[email protected]> * Piggy-back trivial whitespace cleanup that was missed in PR #5669 --------- Signed-off-by: Henry Schreiner <[email protected]> Co-authored-by: Henry Schreiner <[email protected]>
1 parent cc86e8b commit 4587d33

File tree

10 files changed

+532
-25
lines changed

10 files changed

+532
-25
lines changed

docs/advanced/classes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1384,7 +1384,7 @@ You can do that using ``py::custom_type_setup``:
13841384
auto *type = &heap_type->ht_type;
13851385
type->tp_flags |= Py_TPFLAGS_HAVE_GC;
13861386
type->tp_traverse = [](PyObject *self_base, visitproc visit, void *arg) {
1387-
// https://docs.python.org/3/c-api/typeobj.html#c.PyTypeObject.tp_traverse
1387+
// https://docs.python.org/3/c-api/typeobj.html#c.PyTypeObject.tp_traverse
13881388
#if PY_VERSION_HEX >= 0x03090000
13891389
Py_VISIT(Py_TYPE(self_base));
13901390
#endif

docs/advanced/deprecated.rst

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,72 @@
1+
.. _deprecated:
2+
13
Deprecated
24
##########
35

6+
Support for Python 3.8 is deprecated and will be removed in 3.1.
7+
8+
Support for C++11 is deprecated and will be removed in a future version. Please
9+
use at least C++14.
10+
11+
Support for FindPythonLibs (not available in CMake 3.26+ mode) is deprecated
12+
and will be removed in a future version. The default mode is also going to
13+
change to ``"new"`` from ``"compat"`` in the future.
14+
15+
The following features were deprecated before pybind11 3.0, and may be removed
16+
in minor releases of pybind11 3.x.
17+
18+
.. list-table:: Deprecated Features
19+
:header-rows: 1
20+
:widths: 30 15 10
21+
22+
* - Feature
23+
- Deprecated Version
24+
- Year
25+
* - ``py::metaclass()``
26+
- 2.1
27+
- 2017
28+
* - ``PYBIND11_PLUGIN``
29+
- 2.2
30+
- 2017
31+
* - ``py::set_error()`` replacing ``operator()``
32+
- 2.12
33+
- 2024
34+
* - ``get_type_overload``
35+
- 2.6
36+
- 2020
37+
* - ``call()``
38+
- 2.0
39+
- 2016
40+
* - ``.str()``
41+
- ?
42+
-
43+
* - ``.get_type()``
44+
- 2.6
45+
-
46+
* - ``==`` and ``!=``
47+
- 2.2
48+
- 2017
49+
* - ``.check()``
50+
- ?
51+
-
52+
* - ``object(handle, bool)``
53+
- ?
54+
-
55+
* - ``error_already_set.clear()``
56+
- 2.2
57+
- 2017
58+
* - ``obj.attr(…)`` as ``bool``
59+
- ?
60+
-
61+
* - ``.contains``
62+
- ? (maybe 2.4)
63+
-
64+
* - ``py::capsule`` two-argument with destructor
65+
- ?
66+
-
67+
68+
69+
470
.. _deprecated_enum:
571

672
``py::enum_``

0 commit comments

Comments
 (0)