aboutsummaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 60f4903..823cd71 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -188,6 +188,11 @@ impl Log {
///
/// Be careful with encounters that have multiple boss agents, such as Trio
/// and Xera.
+ ///
+ /// # Panics
+ ///
+ /// This function will panic if the boss agent cannot be found. For a more failsafe version,
+ /// see [`Log::boss_agents`].
pub fn boss(&self) -> &Agent {
self.characters()
.find(|c| c.character().id() == self.boss_id)