aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--bot/exts/info/doc/_cog.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/bot/exts/info/doc/_cog.py b/bot/exts/info/doc/_cog.py
index e29e3b717..bd9b589ce 100644
--- a/bot/exts/info/doc/_cog.py
+++ b/bot/exts/info/doc/_cog.py
@@ -135,7 +135,7 @@ class CachedParser:
log.trace("Finished parsing queue.")
def _move_to_front(self, item: Union[QueueItem, DocItem]) -> None:
- """Move `item` to the front of the parse queue."""
+ """Map a DocItem to its page so that the symbol will be parsed once the page is requested."""
# The parse queue stores soups along with the doc symbols in QueueItem objects,
# in case we're moving a DocItem we have to get the associated QueueItem first and then move it.
item_index = self._queue.index(item)