pybind11 icon indicating copy to clipboard operation
pybind11 copied to clipboard

Docs: Include mention of `std::span` in the supported type conversions page

Open parker-research opened this issue 8 months ago • 1 comments

Required prerequisites

  • [x] Make sure you've read the documentation. Your issue may be addressed there.
  • [x] Search the issue tracker and Discussions to verify that this hasn't already been reported. +1 or comment there if it has.
  • [ ] Consider asking first in the Gitter chat room or in a Discussion.

What version (or hash if on master) of pybind11 are you using?

Stable docs

Problem description

On this documentation page, there is no mention of std::span. However, it seems that std::span returned from a C++ function gets converted to a list in Python (which is great).

Would be even better if that was documented on this page: https://pybind11.readthedocs.io/en/stable/advanced/cast/overview.html#conversion-table

It also seems that the docstring/type annotations should indicate that the return type is a list.

Reproducible example code


Is this a regression? Put the last known working version here if it is.

Not a regression

parker-research avatar Apr 07 '25 11:04 parker-research

Docs contributions are always welcome. :)

henryiii avatar Jun 03 '25 14:06 henryiii