From 82b6bd31590d05307cdb1a9608ee0eadb3e375ca Mon Sep 17 00:00:00 2001
From: 45mm <45mm.cartridge421@slmail.me>
Date: Tue, 30 Jan 2024 21:15:22 +0530
Subject: [PATCH] docs(ivy): mention lowered `ivy-sort-max-size`

Depending on the system, this can cause sorting to be disabled long
before the performance hit would be felt, and it's not obvious that this
is the reason.
---
 modules/completion/ivy/README.org | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/modules/completion/ivy/README.org b/modules/completion/ivy/README.org
index 500f22396..d10206b0a 100644
--- a/modules/completion/ivy/README.org
+++ b/modules/completion/ivy/README.org
@@ -176,7 +176,16 @@ A wgrep buffer can be opened from swiper with [[kbd:][C-c C-e]].
 ** TODO Change the position of the ivy childframe
 
 * TODO Troubleshooting
-/There are no known problems with this module./ [[doom-report:][Report one?]]
+** Sorting is not applied at all sometimes
+If the number of candidates is greater than ~ivy-sort-max-size~, sorting will be
+disabled completely. Doom lowers the default value to prevent performance
+issues, so increasing the value may fix your issue:
+#+begin_src elisp
+;;; add to $DOOMDIR/config.el
+(after! ivy
+  (setq ivy-sort-max-size 30000))  ; Doom sets this to 7500, but Ivy's default is 30k
+#+end_src
+
 
 * Frequently asked questions
 [[doom-suggest-faq:][Ask a question?]]