Skip to content

✅ add testing of snippets in README #224

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

Merged
merged 1 commit into from
Apr 8, 2025
Merged

✅ add testing of snippets in README #224

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
4 changes: 4 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,28 +49,28 @@
//! ## Basic example
//!
//! ```rust
//! use serde::{Deserialize, Serialize};
//! use serde_xml_rs::{from_str, to_string};
//!
//! #[derive(Debug, Serialize, Deserialize, PartialEq)]
//! struct Item {
//! name: String,
//! source: String,
//! }
//!
//! fn main() {
//! let src = r#"<?xml version="1.0" encoding="UTF-8"?><Item><name>Banana</name><source>Store</source></Item>"#;
//! let should_be = Item {
//! name: "Banana".to_string(),
//! source: "Store".to_string(),
//! };
//!
//! let item: Item = from_str(src).unwrap();
//! assert_eq!(item, should_be);
//!
//! let reserialized_item = to_string(&item).unwrap();
//! assert_eq!(src, reserialized_item);
//! }

Check warning on line 73 in src/lib.rs

View workflow job for this annotation

GitHub Actions / Clippy Output

needless `fn main` in doctest 

warning: needless `fn main` in doctest
  --> src/lib.rs:52:5
   |
52 |   //! use serde::{Deserialize, Serialize};
   |  _____^
53 | | //! use serde_xml_rs::{from_str, to_string};
54 | | //!
55 | | //! #[derive(Debug, Serialize, Deserialize, PartialEq)]
...  |
72 | | //!     assert_eq!(src, reserialized_item);
73 | | //! }
   | |_____^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_doctest_main
   = note: `#[warn(clippy::needless_doctest_main)]` on by default
//! ```
//!
//! ## Tag contents
Expand Down Expand Up @@ -157,30 +157,30 @@
//! ## Custom EventReader
//!
//! ```rust
//! use serde::{Deserialize, Serialize};
//! use serde_xml_rs::{from_str, to_string, de::Deserializer};
//! use xml::reader::{EventReader, ParserConfig};
//!
//! #[derive(Debug, Serialize, Deserialize, PartialEq)]
//! struct Item {
//! name: String,
//! source: String,
//! }
//!
//! fn main() {
//! let src = r#"<Item><name> Banana </name><source>Store</source></Item>"#;
//! let should_be = Item {
//! name: " Banana ".to_string(),
//! source: "Store".to_string(),
//! };
//!
//! let config = ParserConfig::new()
//! .trim_whitespace(false)
//! .whitespace_to_characters(true);
//! let event_reader = EventReader::new_with_config(src.as_bytes(), config);
//! let item = Item::deserialize(&mut Deserializer::new(event_reader)).unwrap();
//! assert_eq!(item, should_be);
//! }

Check warning on line 183 in src/lib.rs

View workflow job for this annotation

GitHub Actions / Clippy Output

needless `fn main` in doctest 

warning: needless `fn main` in doctest
   --> src/lib.rs:160:5
    |
160 |   //! use serde::{Deserialize, Serialize};
    |  _____^
161 | | //! use serde_xml_rs::{from_str, to_string, de::Deserializer};
162 | | //! use xml::reader::{EventReader, ParserConfig};
163 | | //!
...   |
182 | | //!     assert_eq!(item, should_be);
183 | | //! }
    | |_____^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_doctest_main
//! ```
//!

Expand All @@ -192,3 +192,7 @@
pub use crate::error::Error;
pub use crate::ser::{to_string, to_writer, Serializer};
pub use xml::reader::{EventReader, ParserConfig};

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