aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2021-11-16 00:12:34 +0100
committerDaniel Schadt <kingdread@gmx.de>2021-11-16 00:12:34 +0100
commit8e1e84cac23894f40fab49c03c782ad96d535111 (patch)
tree771cb5e577492271d6dd28756318cfbc8dee651d
parent874af729e94fe8a86085963ca7c9e4f4e66dbea4 (diff)
downloadevtclib-8e1e84cac23894f40fab49c03c782ad96d535111.tar.gz
evtclib-8e1e84cac23894f40fab49c03c782ad96d535111.tar.bz2
evtclib-8e1e84cac23894f40fab49c03c782ad96d535111.zip
Small documentation fix for Encounter
-rw-r--r--src/gamedata.rs8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/gamedata.rs b/src/gamedata.rs
index 24ce288..8f9e3dc 100644
--- a/src/gamedata.rs
+++ b/src/gamedata.rs
@@ -12,7 +12,13 @@ use thiserror::Error;
/// An encounter is a fight or event for which a log can exist. An encounter consists of no, one or
/// multiple bosses. Most encounters map 1:1 to a boss (like Vale Guardian), however there are some
/// encounters with multiple bosses (like Twin Largos), and even encounters without bosses (like
-/// the River of Souls, currently not implemented.).
+/// the River of Souls).
+///
+/// Note that the meaning of "encounter" in the Guild Wars 2 Wiki is not the same as what
+/// [`Encounter`] represents. In many cases, they match, however there are some encounters which
+/// have no associated [`Encounter`] (like Spirit Run or Escort) and some cases where multiple
+/// [`Encounter`]s exist for a single encounter (like the Statues of Grenth encounter in the Hall
+/// of Chains).
///
/// This enum is non-exhaustive to ensure that future encounters can be added without
/// inducing a breaking change.