correct doc tests.

Author: kivikakk

src/html.rs

@@ -123,7 +123,7 @@ pub enum ChildRendering {
 ///         context.write_str(if entering { "<b>" } else { "</b>" })?;
 ///     },
 ///     NodeValue::Image(ref nl) => |context, node, entering| {
-///         assert!(node.get(arena).sourcepos == (3, 1, 3, 18).into());
+///         assert!(node.get(context.arena).sourcepos == (3, 1, 3, 18).into());
 ///         if entering {
 ///             context.write_str(&nl.url.to_uppercase())?;
 ///             return Ok(ChildRendering::Skip);
@@ -132,15 +132,15 @@ pub enum ChildRendering {
 /// });
 ///
 /// let options = Options::default();
-/// let arena = Arena::new();
+/// let mut arena = Arena::new();
 /// let doc = parse_document(
-///     &arena,
+///     &mut arena,
 ///     "_Hello_, **world**.\n\n![title](/img.png)",
 ///     &options,
 /// );
 ///
 /// let mut result: String = String::new();
-/// let converted_count = CustomFormatter::format_document(doc, &options, &mut result, 0).unwrap();
+/// let converted_count = CustomFormatter::format_document(&arena, doc, &options, &mut result, 0).unwrap();
 ///
 /// assert_eq!(
 ///     result,

src/lib.rs

@@ -19,28 +19,28 @@
 //! use comrak::nodes::{AstNode, NodeValue};
 //!
 //! # fn main() {
-//! let arena = Arena::new();
+//! let mut arena = Arena::new();
 //!
 //! let root = parse_document(
-//!     &arena,
-//!     "This is my input.\n\n1. Also [my](#) input.\n2. Certainly *my* input.\n",
+//!     &mut arena,
+//!     "Hello, pretty world!\n\n1. Do you like [pretty](#) paintings?\n2. Or *pretty* music?\n",
 //!     &Options::default());
 //!
-//! for node in root.descendants() {
-//!     if let NodeValue::Text(ref mut text) = node.data.borrow_mut().value {
-//!         *text = text.replace("my", "your");
+//! for node in root.descendants(&arena).collect::<Vec<_>>() {
+//!     if let NodeValue::Text(ref mut text) = node.get_mut(&mut arena).value {
+//!         *text = text.replace("pretty", "beautiful");
 //!     }
 //! }
 //!
 //! let mut html = String::new();
-//! format_html(root, &Options::default(), &mut html).unwrap();
+//! format_html(&arena, root, &Options::default(), &mut html).unwrap();
 //!
 //! assert_eq!(
 //!     &html,
-//!     "<p>This is your input.</p>\n\
+//!     "<p>Hello, beautiful world!</p>\n\
 //!      <ol>\n\
-//!      <li>Also <a href=\"#\">your</a> input.</li>\n\
-//!      <li>Certainly <em>your</em> input.</li>\n\
+//!      <li>Do you like <a href=\"#\">beautiful</a> paintings?</li>\n\
+//!      <li>Or <em>beautiful</em> music?</li>\n\
 //!      </ol>\n");
 //! # }
 //! ```

src/nodes.rs

@@ -663,38 +663,7 @@ impl Ast {
 
 /// The type of a node within the document.
 ///
-/// It is bound by the lifetime `'a`, which corresponds to the `Arena` nodes are
-/// allocated in. Child `Ast`s are wrapped in `RefCell` for interior mutability.
-///
-/// You can construct a new `AstNode` from a `NodeValue` using the `From` trait:
-///
-/// ```no_run
-/// # use comrak::nodes::{AstNode, NodeValue};
-/// let root = AstNode::from(NodeValue::Document);
-/// ```
-///
-/// Note that no sourcepos information is given to the created node. If you wish
-/// to assign sourcepos information, use the `From` trait to create an `AstNode`
-/// from an `Ast`:
-///
-/// ```no_run
-/// # use comrak::nodes::{Ast, AstNode, NodeValue};
-/// let root = AstNode::from(Ast::new(
-///     NodeValue::Paragraph,
-///     (4, 1).into(), // start_line, start_col
-/// ));
-/// ```
-///
-/// Adjust the `end` position manually.
-///
-/// For practical use, you'll probably need it allocated in an `Arena`, in which
-/// case you can use `.into()` to simplify creation:
-///
-/// ```no_run
-/// # use comrak::{nodes::{AstNode, NodeValue}, Arena};
-/// # let arena = Arena::<AstNode>::new();
-/// let node_in_arena = arena.alloc(NodeValue::Document.into());
-/// ```
+/// TODO
 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Debug, Hash)]
 pub struct AstNode(NodeId);
 

src/parser/mod.rs

@@ -392,11 +392,11 @@ pub struct ExtensionOptions<'c> {
     /// use comrak::parse_document;
     /// let mut options = Options::default();
     /// options.extension.front_matter_delimiter = Some("---".to_owned());
-    /// let arena = Arena::new();
+    /// let mut arena = Arena::new();
     /// let input ="---\nlayout: post\n---\nText\n";
-    /// let root = parse_document(&arena, input, &options);
+    /// let root = parse_document(&mut arena, input, &options);
     /// let mut buf = String::new();
-    /// format_commonmark(&root, &options, &mut buf);
+    /// format_commonmark(&arena, root, &options, &mut buf);
     /// assert_eq!(buf, input);
     /// ```
     pub front_matter_delimiter: Option<String>,
@@ -876,17 +876,17 @@ pub struct RenderOptions {
     /// ```
     /// # use comrak::{parse_document, Options, format_commonmark};
     /// # fn main() {
-    /// # let arena = indextree::Arena::new();
+    /// # let mut arena = indextree::Arena::new();
     /// let mut options = Options::default();
-    /// let node = parse_document(&arena, "hello hello hello hello hello hello", &options);
+    /// let node = parse_document(&mut arena, "hello hello hello hello hello hello", &options);
     /// let mut output = String::new();
-    /// format_commonmark(node, &options, &mut output).unwrap();
+    /// format_commonmark(&arena, node, &options, &mut output).unwrap();
     /// assert_eq!(output,
     ///            "hello hello hello hello hello hello\n");
     ///
     /// options.render.width = 20;
     /// let mut output = String::new();
-    /// format_commonmark(node, &options, &mut output).unwrap();
+    /// format_commonmark(&arena, node, &options, &mut output).unwrap();
     /// assert_eq!(output,
     ///            "hello hello hello\nhello hello hello\n");
     /// # }
@@ -1035,18 +1035,18 @@ pub struct RenderOptions {
     /// ```rust
     /// # use std::str;
     /// # use comrak::{Arena, Options, format_commonmark, parse_document};
-    /// let arena = Arena::new();
+    /// let mut arena = Arena::new();
     /// let mut options = Options::default();
     /// let input = "```\nhello\n```\n";
-    /// let root = parse_document(&arena, input, &options);
+    /// let root = parse_document(&mut arena, input, &options);
     ///
     /// let mut buf = String::new();
-    /// format_commonmark(&root, &options, &mut buf);
+    /// format_commonmark(&arena, root, &options, &mut buf);
     /// assert_eq!(buf, "    hello\n");
     ///
     /// buf.clear();
     /// options.render.prefer_fenced = true;
-    /// format_commonmark(&root, &options, &mut buf);
+    /// format_commonmark(&arena, root, &options, &mut buf);
     /// assert_eq!(buf, "```\nhello\n```\n");
     /// ```
     #[cfg_attr(feature = "bon", builder(default))]