From e6cc408ff20df2079f13808c66e2a45e15aaa577 Mon Sep 17 00:00:00 2001
From: bakaq <bakaq@bakaq.net>
Date: Sun, 29 Sep 2024 23:45:40 -0300
Subject: [PATCH] Document test methods

---
 src/machine/mock_wam.rs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/machine/mock_wam.rs b/src/machine/mock_wam.rs
index 2c7e37d6..a4aba112 100644
--- a/src/machine/mock_wam.rs
+++ b/src/machine/mock_wam.rs
@@ -232,10 +232,12 @@ pub(crate) fn parse_and_write_parsed_term_to_heap(
 }
 
 impl Machine {
+    /// For use in tests.
     pub fn with_test_streams() -> Self {
         Machine::new(MachineConfig::default().with_streams(StreamConfig::in_memory()))
     }
 
+    /// For use in tests.
     pub fn test_load_file(&mut self, file: &str) -> Vec<u8> {
         let stream = Stream::from_owned_string(
             std::fs::read_to_string(AsRef::<std::path::Path>::as_ref(file)).unwrap(),
@@ -246,6 +248,7 @@ impl Machine {
         self.user_output.bytes().map(|b| b.unwrap()).collect()
     }
 
+    /// For use in tests.
     pub fn test_load_string(&mut self, code: &str) -> Vec<u8> {
         let stream = Stream::from_owned_string(code.to_owned(), &mut self.machine_st.arena);
 
-- 
2.54.0