Skip to content

docs: prepare for v3.0.0rc1 #5589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 21 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
f683978
Squashed prepv300/manuscript — 30b9c268aeb98308ea42aaccfd5fe454e173c6…
rwgk Mar 30, 2025
1407f09
docs: update changelog
henryiii Mar 31, 2025
9283e00
docs: upgrade guide CMake suggestions
henryiii Mar 31, 2025
204d7c9
[skip ci] Explain type_caster_enum_type_enabled, copyable_holder_cast…
rwgk Apr 7, 2025
b9803c0
[skip ci] Add a small section for py::bind_vector, py::bind_map & py:…
rwgk Apr 7, 2025
5bcdf53
[skip ci] Fix tiny oversight: Reference back to the current release v…
rwgk Apr 7, 2025
2ab459c
Remove sentence: Using self._pybind11_conduit_v1_() ... should keep e…
rwgk Apr 7, 2025
f8ed57c
Changelog: combine #4953 and #5439
rwgk Apr 7, 2025
67fa89c
[skip ci] Trivial whitespace/formatting fixes/enhancements.
rwgk Apr 7, 2025
679978f
chore: add more to deprecation page
henryiii May 17, 2025
a79e3e7
docs: update for recent additions
henryiii May 17, 2025
a5985a5
docs: fixes and set rc1 version
henryiii May 18, 2025
0c76f7e
fix: support rc versions
henryiii May 18, 2025
ee14885
Undo erroneous copilot change: We need to use `detail::enable_if_t`, …
rwgk May 18, 2025
7c93ea6
Empty lines cleanup.
rwgk May 18, 2025
dc2e75f
Rewording of "CMake support now defaults to ..." paragraph.
rwgk May 18, 2025
b6f33e6
[skip ci] Add missing backticks in upgrade guide.
rwgk May 18, 2025
23f7f74
[skip ci] Try :ref:deprecated instead of :doc:deprecated
rwgk May 18, 2025
b7cd0a3
docs: last bit of polish
henryiii May 19, 2025
1e21e37
Merge branch 'master' into prepv300/review
rwgk May 19, 2025
b88e115
[skip ci] Piggy-back trivial whitespace cleanup that was missed in PR…
rwgk May 19, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/advanced/classes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1384,7 +1384,7 @@ You can do that using ``py::custom_type_setup``:
auto *type = &heap_type->ht_type;
type->tp_flags |= Py_TPFLAGS_HAVE_GC;
type->tp_traverse = [](PyObject *self_base, visitproc visit, void *arg) {
// https://docs.python.org/3/c-api/typeobj.html#c.PyTypeObject.tp_traverse
// https://docs.python.org/3/c-api/typeobj.html#c.PyTypeObject.tp_traverse
#if PY_VERSION_HEX >= 0x03090000
Py_VISIT(Py_TYPE(self_base));
#endif
Expand Down
66 changes: 66 additions & 0 deletions docs/advanced/deprecated.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,72 @@
.. _deprecated:

Deprecated
##########

Support for Python 3.8 is deprecated and will be removed in 3.1.

Support for C++11 is deprecated and will be removed in a future version. Please
use at least C++14.

Support for FindPythonLibs (not available in CMake 3.26+ mode) is deprecated
and will be removed in a future version. The default mode is also going to
change to ``"new"`` from ``"compat"`` in the future.

The following features were deprecated before pybind11 3.0, and may be removed
in minor releases of pybind11 3.x.

.. list-table:: Deprecated Features
:header-rows: 1
:widths: 30 15 10

* - Feature
- Deprecated Version
- Year
* - ``py::metaclass()``
- 2.1
- 2017
* - ``PYBIND11_PLUGIN``
- 2.2
- 2017
* - ``py::set_error()`` replacing ``operator()``
- 2.12
- 2024
* - ``get_type_overload``
- 2.6
- 2020
* - ``call()``
- 2.0
- 2016
* - ``.str()``
- ?
-
* - ``.get_type()``
- 2.6
-
* - ``==`` and ``!=``
- 2.2
- 2017
* - ``.check()``
- ?
-
* - ``object(handle, bool)``
- ?
-
* - ``error_already_set.clear()``
- 2.2
- 2017
* - ``obj.attr(…)`` as ``bool``
- ?
-
* - ``.contains``
- ? (maybe 2.4)
-
* - ``py::capsule`` two-argument with destructor
- ?
-



.. _deprecated_enum:

``py::enum_``
Expand Down
Loading