summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--ChangeLog4
-rw-r--r--Completion/Base/Utility/_describe7
2 files changed, 11 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index 3ef78201e..7bb75a493 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
 2015-06-02  Daniel Shahaf  <d.s@daniel.shahaf.name>
 
+	* 35270: Completion/Base/Utility/_describe: _describe: Document
+	a known issue described in 35229 (which is the same thread as
+	35127 and 34768)
+
 	* 35271: Completion/Unix/Command/_beep: New completion:
 	beep.
 
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