bug#30294: 26.0.91; Help string for `imenu-generic-expression'

bug#30294: 26.0.91; Help string for `imenu-generic-expression'

[Francis Wright]

The last paragraph of this help string does not make sense. I think
probably the phrase `"word" syntax' should be deleted.


In GNU Emacs 26.0.91 (build 1, x86_64-w64-mingw32)
 of 2018-01-23 built on MONOLITH
Windowing system distributor 'Microsoft Corp.', version 10.0.16299
Recent messages:
Mark set
Mark saved where search started
Type C-x 1 to delete the help window.
 [2 times]
uncompressing imenu.el.gz...done
Quit
 [2 times]
C-c <mouse-1> is undefined
Quit


Configured using:
 'configure --prefix=/d/emacs/emacs-26.0.91 --without-imagemagick
 --without-dbus'

Configured features:
XPM JPEG TIFF GIF PNG RSVG SOUND NOTIFY ACL GNUTLS LIBXML2 ZLIB
TOOLKIT_SCROLL_BARS LCMS2

Important settings:
  value of $LANG: ENG
  locale-coding-system: cp1252

Major mode: Help

Minor modes in effect:
  shell-dirtrack-mode: t
  show-paren-mode: t
  delete-selection-mode: t
  electric-pair-mode: t
  tooltip-mode: t
  global-eldoc-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  horizontal-scroll-bar-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  buffer-read-only: t
  line-number-mode: t
  transient-mark-mode: t

Load-path shadows:
None found.

Features:
(shadow sort mail-extr emacsbug message rmc puny rfc822 mml mml-sec epa
epg gnus-util rmail rmail-loaddefs mm-decode mm-bodies mm-encode
mail-parse rfc2231 mailabbrev gmm-utils mailheader sendmail rfc2047
rfc2045 ietf-drums mm-util mail-prsvr mail-utils pp reposition jka-compr
cl-extra eieio-opt speedbar sb-image ezimage dframe find-func thingatpt
help-fns radix-tree misearch multi-isearch reduce-run reduce-mode
help-mode cl-print debug vc-dispatcher vc-svn view boot sl derived
compile dired-aux dired dired-loaddefs flyspell ispell imenu tramp
tramp-compat tramp-loaddefs trampver ucs-normalize shell pcomplete
comint ansi-color ring parse-time format-spec advice paren delsel
cus-start cus-load finder-inf info package easymenu epg-config
url-handlers url-parse auth-source cl-seq eieio eieio-core cl-macs
eieio-loaddefs password-cache url-vars seq byte-opt gv bytecomp
byte-compile cconv cl-loaddefs cl-lib elec-pair server time-date
mule-util tooltip eldoc electric uniquify ediff-hook vc-hooks
lisp-float-type mwheel dos-w32 ls-lisp disp-table term/w32-win w32-win
w32-vars term/common-win tool-bar dnd fontset image regexp-opt fringe
tabulated-list replace newcomment text-mode elisp-mode lisp-mode
prog-mode register page menu-bar rfn-eshadow isearch timer select
scroll-bar mouse jit-lock font-lock syntax facemenu font-core
term/tty-colors frame cl-generic cham georgian utf-8-lang misc-lang
vietnamese tibetan thai tai-viet lao korean japanese eucjp-ms cp51932
hebrew greek romanian slovak czech european ethiopic indian cyrillic
chinese composite charscript charprop case-table epa-hook jka-cmpr-hook
help simple abbrev obarray minibuffer cl-preloaded nadvice loaddefs
button faces cus-face macroexp files text-properties overlay sha1 md5
base64 format env code-pages mule custom widget hashtable-print-readable
backquote w32notify w32 lcms2 multi-tty make-network-process emacs)

Memory information:
((conses 16 310264 32274)
 (symbols 56 26656 4)
 (miscs 48 386 278)
 (strings 32 51585 1611)
 (string-bytes 1 1379340)
 (vectors 16 42948)
 (vector-slots 8 798832 13332)
 (floats 8 82 359)
 (intervals 56 7953 20)
 (buffers 992 24))

bug#30294: 26.0.91; Help string for `imenu-generic-expression'

[Noam Postavsky]

Francis Wright <francis.j.wright@gmail.com> writes:

> The last paragraph of this help string does not make sense. I think
> probably the phrase `"word" syntax' should be deleted.

No, it makes sense, it's just hard to parse.  Do you find it clearer
with the patch below?

--- i/lisp/imenu.el
+++ w/lisp/imenu.el
@@ -224,8 +224,8 @@ imenu-generic-expression
 create a buffer index.
 
 For example, see the value of `fortran-imenu-generic-expression'
-used by `fortran-mode' with `imenu-syntax-alist' set locally to
-give the characters which normally have \"symbol\" syntax
+used by `fortran-mode' with `imenu-syntax-alist' set locally so that
+characters which normally have \"symbol\" syntax are considered to have
 \"word\" syntax during matching.")
 ;;;###autoload(put 'imenu-generic-expression 'risky-local-variable t)
 

bug#30294: 26.0.91; Help string for `imenu-generic-expression'

[Noam Postavsky]

tags 30294 fixed
close 30294 26.1
quit

Noam Postavsky <npostavs@users.sourceforge.net> writes:

> +used by `fortran-mode' with `imenu-syntax-alist' set locally so that
> +characters which normally have \"symbol\" syntax are considered to have

Pushed to emacs-26.

[1: 1c2fb04bee]: 2018-02-01 19:26:40 -0500
  * lisp/imenu.el (imenu-generic-expression): Rephrase doc (Bug#30294).
  https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=1c2fb04bee3bb14f4738f864687b03859b0a72ee