From efe00ffa26a660ef3b4b41d1708da2410fcb0678 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fran=C3=A7ois=20Autin?=
 <francois.autin@etudiant.univ-rennes1.fr>
Date: Wed, 19 Apr 2023 18:12:27 +0200
Subject: [PATCH] :memo: Documentation update

---
 src/utility/cfg.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/utility/cfg.rs b/src/utility/cfg.rs
index 68b01fc..f12e51f 100644
--- a/src/utility/cfg.rs
+++ b/src/utility/cfg.rs
@@ -92,6 +92,8 @@ pub fn read_settings() -> Result<Settings, Error> {
     Ok(settings_map)
 }
 
+/// Returns a mock configuration for Machine unit testing
+/// FIXME: Does not cover the whole configuration yet
 pub fn get_debug_configuration() -> Settings {
     let mut settings_map = Settings::new();
     settings_map.insert(MachineSettingKey::PageSize, 128);