Skip to content

Conversation

termoshtt
Copy link
Member

@termoshtt termoshtt commented Jun 21, 2025

@termoshtt termoshtt self-assigned this Jun 21, 2025
@termoshtt termoshtt marked this pull request as ready for review July 5, 2025 06:48
@Copilot Copilot AI review requested due to automatic review settings July 5, 2025 06:48
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR embeds the README into the crate documentation as a doctest and updates the example code block in the README to be ignored during doctest execution.

  • Adds #[doc = include_str!(...)] to include README.md in lib.rs
  • Changes the Rust code fence in README.md to disable doctest execution

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
pyo3-stub-gen/src/lib.rs Includes README.md via #[doc = include_str!(…)]
README.md Updates code fence annotation for the Rust example
Comments suppressed due to low confidence (1)

README.md:98

  • The code fence uses rust:ignore, which isn’t a valid doctest directive. Replace it with rust,ignore or rust,no_run to properly disable example execution.
```rust:ignore

@termoshtt termoshtt merged commit 3790b35 into main Jul 5, 2025
14 checks passed
@termoshtt termoshtt deleted the test-readme branch July 5, 2025 06:53
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.

1 participant