Remove ambiguous statements from documentation

rust-syndication · Nov 16, 2024 · 7b4a6cb · 7b4a6cb
1 parent 273d5ad
commit 7b4a6cb
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. [`#85`](https://github.com/rust-syndication/atom/pull/85)
+
 ## 0.12.4 - 2024-08-28
 
 - Update `quick-xml` to `0.32`. [`#82`](https://github.com/rust-syndication/atom/pull/82)

diff --git a/README.md b/README.md
@@ -52,8 +52,6 @@ let feed = string.parse::<Feed>().unwrap();
 
 A feed can be written to any object that implements the `Write` trait or converted to an XML string using the `ToString` trait.
 
-**Note**: Writing a feed does not perform any escaping of XML entities.
-
 ### Example
 
 ```rust

diff --git a/src/lib.rs b/src/lib.rs
@@ -25,8 +25,6 @@
 //! A feed can be written to any object that implements the `Write` trait or converted to an XML
 //! string using the `ToString` trait.
 //!
-//! **Note**: Writing a feed does not perform any escaping of XML entities.
-//!
 //! ## Example
 //!
 //! ```no_run
-Original file line number
+Diff line change
@@ Expand Up / @@ -52,8 +52,6 @@ let feed = string.parse::<Feed>().unwrap(); @@
     A feed can be written to any object that implements the `Write` trait or converted to an XML string using the `ToString` trait.
-    **Note**: Writing a feed does not perform any escaping of XML entities.
     ### Example
     ```rust
@@ Expand Down @@