From d73e410593de797fe8afc5dfe89b838db0cbd0a5 Mon Sep 17 00:00:00 2001
From: Thomas Coratger <60488569+tcoratger@users.noreply.github.com>
Date: Fri, 15 Dec 2023 14:34:09 +0100
Subject: [PATCH] doc(blockchain-tree): add documentation for
 `MakeCanonicalAction` enum (#5739)

---
 crates/blockchain-tree/src/metrics.rs | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/crates/blockchain-tree/src/metrics.rs b/crates/blockchain-tree/src/metrics.rs
index dcaaaafaaf..7b5e22294a 100644
--- a/crates/blockchain-tree/src/metrics.rs
+++ b/crates/blockchain-tree/src/metrics.rs
@@ -58,16 +58,26 @@ impl MakeCanonicalDurationsRecorder {
     }
 }
 
+/// Represents actions for making a canonical chain.
 #[derive(Debug, Copy, Clone)]
 pub(crate) enum MakeCanonicalAction {
+    /// Cloning old blocks for canonicalization.
     CloneOldBlocks,
+    /// Finding the canonical header.
     FindCanonicalHeader,
+    /// Splitting the chain for canonicalization.
     SplitChain,
+    /// Splitting chain forks for canonicalization.
     SplitChainForks,
+    /// Merging all chains for canonicalization.
     MergeAllChains,
+    /// Updating the canonical index during canonicalization.
     UpdateCanonicalIndex,
+    /// Committing the canonical chain to the database.
     CommitCanonicalChainToDatabase,
+    /// Reverting the canonical chain from the database.
     RevertCanonicalChainFromDatabase,
+    /// Inserting an old canonical chain.
     InsertOldCanonicalChain,
 }