pybind / pybind/pybind11

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

Open Beginner friendly
#5,604 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

triage
Dominant language
C++
Stars
18k
Forks
2.3k
Avg merge
5d 17h
Merged PRs (30d)
10

Description

Required prerequisites
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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.