From 1d0ebd106509af7eb25d6538ae680cf3356d93dc Mon Sep 17 00:00:00 2001 From: Amaan Qureshi Date: Thu, 4 Sep 2025 03:31:43 -0400 Subject: [PATCH] fix(rust): do not interpret readme doc comments as doc tests --- crates/cli/src/tree_sitter_cli.rs | 2 +- crates/config/src/tree_sitter_config.rs | 2 +- crates/highlight/src/highlight.rs | 2 +- crates/loader/src/loader.rs | 2 +- crates/tags/src/tags.rs | 2 +- lib/binding_rust/lib.rs | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/crates/cli/src/tree_sitter_cli.rs b/crates/cli/src/tree_sitter_cli.rs index 9f42a835..7eaa2d35 100644 --- a/crates/cli/src/tree_sitter_cli.rs +++ b/crates/cli/src/tree_sitter_cli.rs @@ -1,4 +1,4 @@ -#![doc = include_str!("../README.md")] +#![cfg_attr(not(any(test, doctest)), doc = include_str!("../README.md"))] pub mod fuzz; pub mod highlight; diff --git a/crates/config/src/tree_sitter_config.rs b/crates/config/src/tree_sitter_config.rs index bca9163f..757ed64e 100644 --- a/crates/config/src/tree_sitter_config.rs +++ b/crates/config/src/tree_sitter_config.rs @@ -1,4 +1,4 @@ -#![doc = include_str!("../README.md")] +#![cfg_attr(not(any(test, doctest)), doc = include_str!("../README.md"))] use std::{env, fs, path::PathBuf}; diff --git a/crates/highlight/src/highlight.rs b/crates/highlight/src/highlight.rs index ee617124..e4555fa0 100644 --- a/crates/highlight/src/highlight.rs +++ b/crates/highlight/src/highlight.rs @@ -1,4 +1,4 @@ -#![doc = include_str!("../README.md")] +#![cfg_attr(not(any(test, doctest)), doc = include_str!("../README.md"))] pub mod c_lib; use core::slice; diff --git a/crates/loader/src/loader.rs b/crates/loader/src/loader.rs index 08c7d6fe..4ea0475b 100644 --- a/crates/loader/src/loader.rs +++ b/crates/loader/src/loader.rs @@ -1,4 +1,4 @@ -#![doc = include_str!("../README.md")] +#![cfg_attr(not(any(test, doctest)), doc = include_str!("../README.md"))] #![cfg_attr(docsrs, feature(doc_cfg))] #[cfg(any(feature = "tree-sitter-highlight", feature = "tree-sitter-tags"))] diff --git a/crates/tags/src/tags.rs b/crates/tags/src/tags.rs index 8334fac2..57179e9a 100644 --- a/crates/tags/src/tags.rs +++ b/crates/tags/src/tags.rs @@ -1,4 +1,4 @@ -#![doc = include_str!("../README.md")] +#![cfg_attr(not(any(test, doctest)), doc = include_str!("../README.md"))] pub mod c_lib; diff --git a/lib/binding_rust/lib.rs b/lib/binding_rust/lib.rs index 963469fb..5cd6db14 100644 --- a/lib/binding_rust/lib.rs +++ b/lib/binding_rust/lib.rs @@ -1,4 +1,4 @@ -#![doc = include_str!("./README.md")] +#![cfg_attr(not(any(test, doctest)), doc = include_str!("../README.md"))] #![cfg_attr(not(feature = "std"), no_std)] #![cfg_attr(docsrs, feature(doc_cfg))]