Remove ambiguous statements from documentation

rust-syndication · Nov 15, 2024 · bdb8694 · bdb8694
1 parent 27d2887
commit bdb8694
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Remove ambiguous statements about escaping from documentation. [`#171`](https://github.com/rust-syndication/rss/pull/171)
+
 ## 2.0.9 - 2024-08-28
 
 - Fix Clippy Warnings. [`#164`](https://github.com/rust-syndication/rss/pull/164)

diff --git a/README.md b/README.md
@@ -70,8 +70,6 @@ async fn example_feed() -> Result<Channel, Box<dyn Error>> {
 
 A channel can be written to any object that implements the `Write` trait or converted to an XML string using the `ToString` trait.
 
-**Note**: Writing a channel does not perform any escaping of XML entities.
-
 ```rust
 use rss::Channel;
 

diff --git a/src/lib.rs b/src/lib.rs
@@ -48,8 +48,6 @@
 //! A channel can be written to any object that implements the `Write` trait or converted to an
 //! XML string using the `ToString` trait.
 //!
-//! **Note**: Writing a channel does not perform any escaping of XML entities.
-//!
 //! ```rust
 //! use rss::Channel;
 //!
-Original file line number
+Diff line change
@@ Expand Up / @@ -70,8 +70,6 @@ async fn example_feed() -> Result<Channel, Box<dyn Error>> { @@
     A channel can be written to any object that implements the `Write` trait or converted to an XML string using the `ToString` trait.
-    **Note**: Writing a channel does not perform any escaping of XML entities.
     ```rust
     use rss::Channel;
@@ Expand Down @@