Skip to content

doc: update README doctests #1314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −5
Open

doc: update README doctests #1314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,8 +189,6 @@ default-features = false
[dev-dependencies]
# For property based tests.
quickcheck = { version = "1.0.3", default-features = false }
# To check README's example
doc-comment = "0.3"
# For easy error handling in integration tests.
anyhow = "1.0.69"
# A library for testing regex engines.
Expand Down
1 change: 0 additions & 1 deletion regex-automata/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@ regex-syntax = { path = "../regex-syntax", version = "0.8.5", optional = true, d
[dev-dependencies]
anyhow = "1.0.69"
bstr = { version = "1.3.0", default-features = false, features = ["std"] }
doc-comment = "0.3.3"
quickcheck = { version = "1.0.3", default-features = false }
regex-test = { path = "../regex-test", version = "0.1.0" }

Expand Down
3 changes: 2 additions & 1 deletion regex-automata/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -630,8 +630,9 @@ extern crate std;
#[cfg(feature = "alloc")]
extern crate alloc;

#[doc = include_str!("../README.md")]
#[cfg(doctest)]
doc_comment::doctest!("../README.md");
pub struct ReadmeDoctests;

#[doc(inline)]
pub use crate::util::primitives::PatternID;
Expand Down
3 changes: 2 additions & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1324,8 +1324,9 @@ this for literal optimizations.
#![cfg_attr(docsrs_regex, feature(doc_cfg))]
#![warn(missing_debug_implementations)]

#[doc = include_str!("../README.md")]
#[cfg(doctest)]
doc_comment::doctest!("../README.md");
pub struct ReadmeDoctests;

extern crate alloc;
#[cfg(any(test, feature = "std"))]
Expand Down