Docs: Include mention of `std::span` in the supported type conversions page
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 18k
- Forks
- 2.3k
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 10
Description
Required prerequisites
- Make sure you've read the documentation. Your issue may be addressed there.
- 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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the stable advanced/cast/overview.html conversion table linked in the issue and locate its supported type conversions section. Add the documented std::span-to-list behavior and clarify the return type annotation, with the page accurately describing both outcomes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 62/100