From f9994c516a9ec9d7977d1a4273ad5252ef3877b1 Mon Sep 17 00:00:00 2001
From: Stefano Pigozzi <me@steffo.eu>
Date: Fri, 24 Mar 2023 12:46:25 +0100
Subject: [PATCH] Add doctest for `champions`

---
 src/data/deckcode/deck.rs | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/src/data/deckcode/deck.rs b/src/data/deckcode/deck.rs
index 3a42e04..08c463c 100644
--- a/src/data/deckcode/deck.rs
+++ b/src/data/deckcode/deck.rs
@@ -412,6 +412,22 @@ impl Deck {
     }
 
     /// Get an [`Iterator`] of all Champion [`Card`]s in the deck.
+    ///
+    /// ```rust
+    /// use patched_porobot::deck;
+    /// use patched_porobot::data::deckcode::deck::Deck;
+    /// use patched_porobot::data::setbundle::card::CardIndex;
+    /// use patched_porobot::data::setbundle::code::CardCode;
+    /// use patched_porobot::data::setbundle::create_cardindex_from_wd;
+    ///
+    /// let index: CardIndex = create_cardindex_from_wd();
+    /// let deck: Deck = deck!("CECQCAQCA4AQIAYKAIAQGLRWAQAQECAPEUXAIAQDAEBQOCIBAIAQEMJYAA");
+    /// let champions = deck.champions(&index);
+    ///
+    /// let champion_codes: Vec<&str> = champions.map(|c| c.code.full.as_str()).collect();
+    /// const EXPECTED_CODES: [&str; 2] = ["01IO015", "02NX007"];
+    /// assert_eq!(champion_codes, EXPECTED_CODES)
+    /// ```
     pub fn champions<'a>(&'a self, cards: &'a CardIndex) -> impl Iterator<Item = &'a Card> {
         self.contents.keys()
             .filter_map(|cc| cc.to_card(cards))