From 4820661d1e0c0ba9457f19b9a17d4adc71af6682 Mon Sep 17 00:00:00 2001
From: Florian Schmaus <flow@cs.fau.de>
Date: Mon, 21 Feb 2022 08:34:32 +0100
Subject: [PATCH] [StealingResult] Improve docstring
---
emper/StealingResult.hpp | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/emper/StealingResult.hpp b/emper/StealingResult.hpp
index a56792d0..e0e9d515 100644
--- a/emper/StealingResult.hpp
+++ b/emper/StealingResult.hpp
@@ -6,7 +6,8 @@ namespace emper {
/*! Enum representing the different outcomes of a stealing attempt */
enum class StealingResult {
Empty, /*!< indicate there was nothing to steal*/
- LostRace, /*!< indicate the attempt to steal was unsuccessful because someone else was faster */
+ LostRace, /*!< indicate the attempt to steal was unsuccessful because there was a concurrent
+ access and we lost the race */
Stolen, /*!< indicate a successful stealing attempt */
};
} // namespace emper
--
GitLab