From a71e1031ced86fa901b44761e44122d0608cf6d5 Mon Sep 17 00:00:00 2001
From: Paul Hauner <paul@paulhauner.com>
Date: Fri, 1 Feb 2019 17:07:59 +1100
Subject: [PATCH] Add docstrings to finalized_head

---
 beacon_node/beacon_chain/src/finalized_head.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/beacon_node/beacon_chain/src/finalized_head.rs b/beacon_node/beacon_chain/src/finalized_head.rs
index 76a20a2c2..ac2917fdb 100644
--- a/beacon_node/beacon_chain/src/finalized_head.rs
+++ b/beacon_node/beacon_chain/src/finalized_head.rs
@@ -7,6 +7,7 @@ where
     T: ClientDB,
     U: SlotClock,
 {
+    /// Update the justified head to some new values.
     pub fn update_finalized_head(
         &self,
         new_beacon_block: BeaconBlock,
@@ -23,6 +24,8 @@ where
         );
     }
 
+    /// Returns a read-lock guarded `CheckPoint` struct for reading the justified head (as chosen,
+    /// indirectly,  by the fork-choice rule).
     pub fn finalized_head(&self) -> RwLockReadGuard<CheckPoint> {
         self.finalized_head.read()
     }