From bbfb1460870c27e1baab6bf40860d88030e487e9 Mon Sep 17 00:00:00 2001
From: Stefano Pigozzi <me@steffo.eu>
Date: Mon, 22 Aug 2022 18:01:32 +0200
Subject: [PATCH] Document deck queries in the bot's instructions

---
 src/bin/patched_porobot_telegram.rs | 24 +++++++++++++++++-------
 1 file changed, 17 insertions(+), 7 deletions(-)

diff --git a/src/bin/patched_porobot_telegram.rs b/src/bin/patched_porobot_telegram.rs
index 41e7e30..7abdd6a 100644
--- a/src/bin/patched_porobot_telegram.rs
+++ b/src/bin/patched_porobot_telegram.rs
@@ -1,12 +1,12 @@
 //! # [@patchedporobot]
 //!
-//! Inline bot for searching and sending Legends of Runeterra cards in Telegram chats
+//! Inline bot for searching and sending Legends of Runeterra cards and decks in Telegram chats
 //!
 //! ## Usage
 //!
 //! [@patchedporobot] is a inline bot: this means that you can use it everywhere, without having to add it to chats.
 //!
-//! ### Basic queries
+//! ### Card queries
 //!
 //! You can search for a card by entering in the "Write a message..." bot the username of the bot, followed by the card you want to search for:
 //!
@@ -26,7 +26,7 @@
 //! @patchedporobot piltover poro
 //! ```
 //!
-//! ### Conjunctions
+//! #### Conjunctions
 //!
 //! By default, all terms in the query are joined by `AND` conjuctions, meaning that only cards containing **all** of the terms are retrieved.
 //!
@@ -42,7 +42,7 @@
 //! @patchedporobot von AND yipp OR cat
 //! ```
 //!
-//! ### Fields
+//! #### Fields
 //!
 //! You can perform searches about specific card properties:
 //!
@@ -56,11 +56,11 @@
 //! @patchedporobot name:Bard OR description:Chime
 //! ```
 //!
-//! #### Supported fields
+//! ##### Supported fields
 //!
 //! [@patchedporobot] supports the various fields for searching cards: see [**this table**](patched_porobot::search::cardsearch::CardSearchEngine::schema) for a list of all of them!
 //!
-//! ### Ranges
+//! #### Ranges
 //!
 //! Finally, you can request specific ranges for your search using square brackets and the `TO` keyword:
 //!
@@ -68,10 +68,20 @@
 //! @patchedporobot attack:[8 TO 12]
 //! ```
 //!
-//! ### Query parser
+//! #### Query parser
 //!
 //! Since [@patchedporobot] uses [`tantivy`] internally, you might find more information on even more advanced queries in the [documentation of their `QueryParser`](tantivy::query::QueryParser)!
 //!
+//! ### Deck queries
+//!
+//! You can have [@patchedporobot] display a deck and its cards by pasting the deck code after the bot's username:
+//!
+//! ```text
+//! @patchedporobot CIBQCAICAQAQGBQIBEBAMBAJBMGBUHJNGE4AEAIBAIYQEAQGEU2QCAIBAIUQ
+//! ```
+//!
+//! Then, select the "Deck with N cards" option to send the deck's card list in the chat!
+//!
 //!
 //! [@patchedporobot]: https://t.me/patchedporobot