emacs/lisp/help-mode.el, branch scratch/flymake-augment-api Emacs is the extensible, customizable, self-documenting real-time display editor. Prefer HTTPS to FTP and HTTP in documentation 2017-09-13T22:54:37+00:00 Paul Eggert 2017-09-13T22:52:52+00:00 bc511a64f6da9ab51acc7c8865e80c4a4cb655c2 Most of this change is to boilerplate commentary such as license URLs. This change was prompted by ftp://ftp.gnu.org's going-away party, planned for November. Change these FTP URLs to https://ftp.gnu.org instead. Make similar changes for URLs to other organizations moving away from FTP. Also, change HTTP to HTTPS for URLs to gnu.org and fsf.org when this works, as this will further help defend against man-in-the-middle attacks (for this part I omitted the MS-DOS and MS-Windows sources and the test tarballs to keep the workload down). HTTPS is not fully working to lists.gnu.org so I left those URLs alone for now. 
Most of this change is to boilerplate commentary such as license URLs.
This change was prompted by ftp://ftp.gnu.org's going-away party,
planned for November.  Change these FTP URLs to https://ftp.gnu.org
instead.  Make similar changes for URLs to other organizations moving
away from FTP.  Also, change HTTP to HTTPS for URLs to gnu.org and
fsf.org when this works, as this will further help defend against
man-in-the-middle attacks (for this part I omitted the MS-DOS and
MS-Windows sources and the test tarballs to keep the workload down).
HTTPS is not fully working to lists.gnu.org so I left those URLs alone
for now.
Make "C-h o" show faces as well as variables 2017-08-05T08:51:05+00:00 Alexander Gramiak 2017-08-05T08:51:05+00:00 8a577e9468136c7bbcb1627917c4b8c124547f6c * lisp/faces.el (describe-face): Return (buffer-string). Reorder the placement of variables/faces in describe-symbol, to put more emphasis on the variable entry rather than the face. (Bug#24543) 
* lisp/faces.el (describe-face): Return (buffer-string).  Reorder
the placement of variables/faces in describe-symbol, to put more
emphasis on the variable entry rather than the face.  (Bug#24543)
Give , and .@ doc strings. Fixes bug #24561. 2017-01-23T19:00:49+00:00 Alan Mackenzie 2017-01-23T19:00:49+00:00 0c31ff43b6880c84498fbe1f06e1e5809b55e838 Also make *Help* links to ``' possible. Also make usable as such doc strings on the function-documentation property of a symbol. * lisp/emacs-lisp/backquote.el (top-level): Give , and '@ doc strings on the function-documentation property. Also give these symbols a reader-construct property. * lisp/help-fns.el (describe-function): Allow the function-documentation property to work. Use princ rather than prin1 to print the function's name when it has a reader-construct property. (help-fns-signature): Don't insert `high-usage' for a reader-construct. (describe-function-1): Adapt to process documentation on the function-documentation property. Print "a reader construct" when appropriate. * lisp/help-mode.el (help-xref-symbol-regexp): Amend this regexp also to match ``'. 
Also make *Help* links to ``' possible.  Also make usable as such doc strings
on the function-documentation property of a symbol.

* lisp/emacs-lisp/backquote.el (top-level): Give , and '@ doc strings on the
function-documentation property.  Also give these symbols a reader-construct
property.

* lisp/help-fns.el (describe-function): Allow the function-documentation
property to work.  Use princ rather than prin1 to print the function's name
when it has a reader-construct property.
(help-fns-signature): Don't insert `high-usage' for a reader-construct.
(describe-function-1): Adapt to process documentation on the
function-documentation property.  Print "a reader construct" when appropriate.

* lisp/help-mode.el (help-xref-symbol-regexp): Amend this regexp also to match
``'.
Update copyright year to 2017 2017-01-01T03:42:26+00:00 Paul Eggert 2017-01-01T03:14:01+00:00 5badc81c1cdfbb261ad3e6d1b753defb15712f26 Run admin/update-copyright. 
Run admin/update-copyright.
Run find-function-after-hook after finding a symbol 2016-09-23T13:36:24+00:00 Tino Calancha 2016-04-25T17:27:06+00:00 dc1e0ac761725931f23de13df4ef5020372a52a0 * lisp/emacs-lisp/find-func.el (find-library): * lisp/help-mode.el (help-function-def, help-variable-def): Run `find-function-after-hook' inside the help-function of the buttons (bug#22583). * etc/NEWS: Mention the change. This is a backport from master. (cherry picked from commit f069d854508946bcc03e4c77ceb430748e3ab6d7) 
* lisp/emacs-lisp/find-func.el (find-library):
* lisp/help-mode.el (help-function-def, help-variable-def):
Run `find-function-after-hook' inside the help-function of the
buttons (bug#22583).
* etc/NEWS: Mention the change.

This is a backport from master.
(cherry picked from commit f069d854508946bcc03e4c77ceb430748e3ab6d7)
Make buttons in header lines work 2016-02-23T09:47:24+00:00 Vaidheeswaran C 2016-02-23T09:46:00+00:00 42bc065a6a05995ec365a5df09100989c03b822c * lisp/help-mode.el (help-button-action): `help-xref-button' in header line doesn't work (bug#21024). Backport: (cherry picked from commit c11e565a6b6d09fa39d4c3ef65bef08190eaecc1) 
* lisp/help-mode.el (help-button-action): `help-xref-button' in
header line doesn't work (bug#21024).

Backport:

(cherry picked from commit c11e565a6b6d09fa39d4c3ef65bef08190eaecc1)
Update copyright year to 2016 2016-01-01T09:34:24+00:00 Paul Eggert 2016-01-01T09:16:19+00:00 0e963201d03d9229bb8ac4323291d2b0119526ed Run admin/update-copyright. 
Run admin/update-copyright.
Fix doc-string of `help-mode-finish'. 2015-08-19T09:33:25+00:00 Martin Rudalics 2015-08-19T09:33:25+00:00 7047d3642fb20955b83c1dfb3d5a70d869072731 * lisp/help-mode.el (help-mode-finish): Fix doc-string. 
* lisp/help-mode.el (help-mode-finish): Fix doc-string.
Add doc strings to 2 help-mode.el functions 2015-08-15T08:26:36+00:00 Eli Zaretskii 2015-08-15T08:26:36+00:00 5bbc55fcdb050e421286a6f9e51c7732cbf6eebe * lisp/help-mode.el (help-mode-setup, help-mode-finish): Add doc strings. (Bug#21263) 
* lisp/help-mode.el (help-mode-setup, help-mode-finish): Add doc
strings.  (Bug#21263)
Add online-help support to describe types 2015-07-07T06:14:16+00:00 Stefan Monnier 2015-07-07T06:14:16+00:00 59b5723c9b613f14cd60cd3239cfdbc0d2343b18 * lisp/help-fns.el (describe-symbol-backends): Move to help-mode.el. (describe-symbol): Improve the selection of default. * lisp/help-mode.el: Require cl-lib. (describe-symbol-backends): Move from help-fns.el. (help-make-xrefs): Use it. * lisp/emacs-lisp/cl-extra.el (describe-symbol-backends): Add entry for types. (cl--typedef-regexp): New const. (find-function-regexp-alist): Add entry for types. (cl-help-type, cl-type-definition): New buttons. (cl-find-class): New function. (cl-describe-type): New command. (cl--describe-class, cl--describe-class-slot) (cl--describe-class-slots): New functions, moved from eieio-opt.el. * lisp/emacs-lisp/cl-generic.el (cl--generic-method-documentation) (cl--generic-all-functions, cl--generic-specializers-apply-to-type-p): New functions. Moved from eieio-opt.el. (cl--generic-class-parents): New function, extracted from cl--generic-struct-specializers. (cl--generic-struct-specializers): Use it. * lisp/emacs-lisp/cl-macs.el (cl-defstruct): Use pcase-dolist. Improve constructor's docstrings. (cl-struct-unknown-slot): New error. (cl-struct-slot-offset): Use it. * lisp/emacs-lisp/cl-preloaded.el (cl-struct-define): Record the type definition in current-load-list. * lisp/emacs-lisp/eieio-core.el (eieio--known-slot-names): New var. (eieio--add-new-slot): Set it. (eieio-defclass-internal): Use new name for current-load-list. (eieio-oref): Add compiler-macro to warn about unknown slots. * lisp/emacs-lisp/eieio.el (defclass): Update eieio--known-slot-names as compile-time as well. Improve constructor docstrings. * lisp/emacs-lisp/eieio-opt.el (eieio-help-class) (eieio--help-print-slot, eieio-help-class-slots): Move to cl-extra.el. (eieio-class-def): Remove button. (eieio-help-constructor): Use new name for load-history element. (eieio--specializers-apply-to-class-p, eieio-all-generic-functions) (eieio-method-documentation): Move to cl-generic.el. (eieio-display-method-list): Use new names. * lisp/emacs-lisp/lisp-mode.el (lisp-imenu-generic-expression): Add "define-linline". (lisp-fdefs): Remove "defsubst". (el-fdefs): Add "defsubst", "cl-defsubst", and "define-linline". * lisp/emacs-lisp/macroexp.el (macroexp--warned): New var. (macroexp--warn-and-return): Use it to avoid inf-loops. Add `compile-only' argument. 
* lisp/help-fns.el (describe-symbol-backends): Move to help-mode.el.
(describe-symbol): Improve the selection of default.

* lisp/help-mode.el: Require cl-lib.
(describe-symbol-backends): Move from help-fns.el.
(help-make-xrefs): Use it.

* lisp/emacs-lisp/cl-extra.el (describe-symbol-backends): Add entry
for types.
(cl--typedef-regexp): New const.
(find-function-regexp-alist): Add entry for types.
(cl-help-type, cl-type-definition): New buttons.
(cl-find-class): New function.
(cl-describe-type): New command.
(cl--describe-class, cl--describe-class-slot)
(cl--describe-class-slots): New functions, moved from eieio-opt.el.

* lisp/emacs-lisp/cl-generic.el (cl--generic-method-documentation)
(cl--generic-all-functions, cl--generic-specializers-apply-to-type-p):
New functions.  Moved from eieio-opt.el.
(cl--generic-class-parents): New function, extracted from
cl--generic-struct-specializers.
(cl--generic-struct-specializers): Use it.

* lisp/emacs-lisp/cl-macs.el (cl-defstruct): Use pcase-dolist.
Improve constructor's docstrings.
(cl-struct-unknown-slot): New error.
(cl-struct-slot-offset): Use it.

* lisp/emacs-lisp/cl-preloaded.el (cl-struct-define): Record the type
definition in current-load-list.

* lisp/emacs-lisp/eieio-core.el (eieio--known-slot-names): New var.
(eieio--add-new-slot): Set it.
(eieio-defclass-internal): Use new name for current-load-list.
(eieio-oref): Add compiler-macro to warn about unknown slots.
* lisp/emacs-lisp/eieio.el (defclass): Update eieio--known-slot-names
as compile-time as well.  Improve constructor docstrings.

* lisp/emacs-lisp/eieio-opt.el (eieio-help-class)
(eieio--help-print-slot, eieio-help-class-slots): Move to cl-extra.el.
(eieio-class-def): Remove button.
(eieio-help-constructor): Use new name for load-history element.
(eieio--specializers-apply-to-class-p, eieio-all-generic-functions)
(eieio-method-documentation): Move to cl-generic.el.
(eieio-display-method-list): Use new names.

* lisp/emacs-lisp/lisp-mode.el (lisp-imenu-generic-expression):
Add "define-linline".
(lisp-fdefs): Remove "defsubst".
(el-fdefs): Add "defsubst", "cl-defsubst", and "define-linline".

* lisp/emacs-lisp/macroexp.el (macroexp--warned): New var.
(macroexp--warn-and-return): Use it to avoid inf-loops.
Add `compile-only' argument.