about summary refs log tree commit diff
path: root/Completion/Base/Utility
diff options
context:
space:
mode:
authorDaniel Shahaf <d.s@daniel.shahaf.name>2015-05-23 10:03:24 +0000
committerDaniel Shahaf <d.s@daniel.shahaf.name>2015-06-02 10:13:50 +0000
commitce9d3fd7b727ddcc7bd09d789a47f15d16762534 (patch)
treefdabf362303d208f7b1a441e1d4acce1cace9d32 /Completion/Base/Utility
parent83ac36c14f3457f49b77bba9b806d2577a6128f3 (diff)
downloadzsh-ce9d3fd7b727ddcc7bd09d789a47f15d16762534.tar.gz
zsh-ce9d3fd7b727ddcc7bd09d789a47f15d16762534.tar.xz
zsh-ce9d3fd7b727ddcc7bd09d789a47f15d16762534.zip
35270: _describe: Document a known issue described in 35229
(which is the same thread as 35127 and 34768)
Diffstat (limited to 'Completion/Base/Utility')
-rw-r--r--Completion/Base/Utility/_describe7
1 files changed, 7 insertions, 0 deletions
diff --git a/Completion/Base/Utility/_describe b/Completion/Base/Utility/_describe
index ab7200517..76ab1d995 100644
--- a/Completion/Base/Utility/_describe
+++ b/Completion/Base/Utility/_describe
@@ -1,5 +1,12 @@
 #autoload
 
+# ### Note: Calling this function twice during one completion operation, such
+# ### that in each call there exists a pair of items having the same description
+# ### as each other, and the two calls specify the same $_type, currently leads
+# ### to garbled output; see workers/35229 (May 2015) and its thread (which also
+# ### discusses at least two other issues, that may or may not be related to
+# ### this one).
+
 # This can be used to add options or values with descriptions as matches.
 
 local _opt _expl _tmpm _tmpd _mlen _noprefix