Skip to content

docs: Add an example for wrap_pyfunction#5923

Open
Alc-Alc wants to merge 2 commits intoPyO3:mainfrom
Alc-Alc:docs-for-wrap_pyfunction
Open

docs: Add an example for wrap_pyfunction#5923
Alc-Alc wants to merge 2 commits intoPyO3:mainfrom
Alc-Alc:docs-for-wrap_pyfunction

Conversation

@Alc-Alc
Copy link
Copy Markdown

@Alc-Alc Alc-Alc commented Mar 29, 2026

  • Add an example for wrap_pyfunction
  • Clarify in function.md that the macro docs includes an example

Clarify in `function.md` that the macro docstring includes an example
@Alc-Alc Alc-Alc changed the title docs(macros): Add an example for wrap_pyfunction docs: Add an example for wrap_pyfunction Mar 29, 2026
@Alc-Alc
Copy link
Copy Markdown
Author

Alc-Alc commented Mar 29, 2026

  1. I am not sure how to backlink to the "examples" section in docstring from the markdown files, so I added a note to indicate that an example exists, can be removed if redundant.
  2. Can a maintainer / anyone help me with the CI? I ran cargo test --doc macros locally and the added docstring does pass locally.

@winstxnhdw
Copy link
Copy Markdown

  1. I am not sure how to backlink to the "examples" section in docstring from the markdown files, so I added a note to indicate that an example exists, can be removed if redundant.

Why not just link to the line number range?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants