From 91f98e3905ab0b34463cf24655cd433fcef7643a Mon Sep 17 00:00:00 2001
From: Christopher Wells <cwellsny@nycap.rr.com>
Date: Sat, 11 Nov 2023 19:30:35 -0800
Subject: [PATCH] Add docs for load_elemental_type

---
 cbpickaxe/hoylake.py | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/cbpickaxe/hoylake.py b/cbpickaxe/hoylake.py
index 1d54e33..b56fadf 100644
--- a/cbpickaxe/hoylake.py
+++ b/cbpickaxe/hoylake.py
@@ -65,6 +65,14 @@ def load_root(self, name: str, new_root: str | os.PathLike) -> None:
         self.__load_translation_tables(new_root)
 
     def load_elemental_type(self, path: str) -> Tuple[RootName, ElementalType]:
+        """
+        Loads in the elemental type at the given res:// filepath.
+
+        Must have loaded at least one root before running.
+
+        If there is no elemental type file at that location in any of the loaded root directories,
+        then a ValueError will be raised.
+        """
         self.__check_if_root_loaded()
 
         relative_path = Hoylake.__parse_res_path(path)