helpful, branch HEAD

Add back/forward navigation commands

2026-09-26T06:37:47Z

commit 980888ab4e1bce741f3d9473ab6639933a2f2dae parent 03756fa6ad4dcca5e0920622b1ee3f70abfc4e39 Author: andsy10 Date: Sat, 26 Sep 2026 14:37:47 +0800 Add back/forward navigation commands

Fix typo in doc comment

2025-04-08T02:51:41Z

commit 03756fa6ad4dcca5e0920622b1ee3f70abfc4e39 parent 6a4d5e0760ba96a24cd13052233c6edfb34d022c Author: Richard M. <148184265+Richard1813@users.noreply.github.com> Date: Tue, 8 Apr 2025 14:51:41 +1200 Fix typo in doc comment Change "helful" to "helpful"

Adapt helpful--keymaps-containing for Emacs 30+

2025-02-26T23:43:18Z

commit 6a4d5e0760ba96a24cd13052233c6edfb34d022c parent 3794389ef685b6a59b3a487d0492c3add3c42c2f Author: Xiyue Deng Date: Wed, 26 Feb 2025 15:43:18 -0800 Adapt helpful--keymaps-containing for Emacs 30+ The output of helpful--keymaps-containing changed since Emacs 30.x. This patch adapts its test for newer Emacs versions.

Check for interpreted-function-p

2025-02-26T23:39:42Z

commit 3794389ef685b6a59b3a487d0492c3add3c42c2f parent 5ad8a9ce57b6c076428286c3d25968b449ab6fd3 Author: Xiyue Deng Date: Wed, 26 Feb 2025 15:39:42 -0800 Check for interpreted-function-p Emacs 30.x added interpreted-function which is different from byte-code-function, and hence helpful--signature will try to treat it like a lambda which will fail with ,---- | (wrong-type-argument listp #[(x) (x) (t) nil "Foo"]) `---- This patch adds tests for such case using interpreted-function-p when it's available.

fix: Improve variable setting logic in helpful.el

2025-02-20T03:28:00Z

commit 5ad8a9ce57b6c076428286c3d25968b449ab6fd3 parent 34328c639ed7aad371a3f57209acad2a5bb66401 Author: StrawberryTea Date: Wed, 19 Feb 2025 22:28:00 -0500 fix: Improve variable setting logic in helpful.el

handle `package-version` safely to prevent `listp` error

2024-08-28T09:28:16Z

commit 34328c639ed7aad371a3f57209acad2a5bb66401 parent 4ba24cac9fb14d5fdc32582cd947572040e82b2c Author: Sau P Date: Wed, 28 Aug 2024 10:28:16 +0100 handle `package-version` safely to prevent `listp` error When `package-version' is not what we expect (e.g a simple string), a `listp` error is thrown and you are unable to view the variable documentation due to it. This now handles it and provides a fallback value.

Fix scan-sexps error for C-defined variables

2024-01-06T10:30:30Z

commit 4ba24cac9fb14d5fdc32582cd947572040e82b2c parent a835b7ec59004a13f4a09ff127a785a92b957e8f Author: StrawberryTea Date: Sat, 6 Jan 2024 04:30:30 -0600 Fix scan-sexps error for C-defined variables

Fix wrong-type-argument error in helpful-key

2023-12-26T01:11:05Z

commit a835b7ec59004a13f4a09ff127a785a92b957e8f parent a32a5b3d959a7fccf09a71d97b3d7c888ac31c69 Author: mmarshall540 <62682447+mmarshall540@users.noreply.github.com> Date: Mon, 25 Dec 2023 20:11:05 -0500 Fix wrong-type-argument error in helpful-key

Use setopt for "set" button if available

2023-10-19T13:06:44Z

commit a32a5b3d959a7fccf09a71d97b3d7c888ac31c69 parent be6f7bb6d7371619f076e55bc7449002f0725478 Author: StrawberryTea Date: Thu, 19 Oct 2023 08:06:44 -0500 Use setopt for "set" button if available

Test CI on Emacs 29

2023-10-07T21:43:12Z

commit be6f7bb6d7371619f076e55bc7449002f0725478 parent 79cae33c7b4edc2679c81e219d41d890b5eaac73 Author: Wilfred Hughes Date: Sat, 7 Oct 2023 14:43:12 -0700 Test CI on Emacs 29

Repair helpful--display-implementations test for emacs 29.1

2023-08-10T18:03:52Z

commit 79cae33c7b4edc2679c81e219d41d890b5eaac73 parent 737ff828d763e156a6072a532f2c3d2d0c26178e Author: aagon Date: Thu, 10 Aug 2023 20:03:52 +0200 Repair helpful--display-implementations test for emacs 29.1

Look for "function" or "variable" text in doc comments case-insensitively

2023-10-07T21:41:28Z

commit 737ff828d763e156a6072a532f2c3d2d0c26178e parent 2b50adfd7a33a1c3f8d68f06d50d779459956ada Author: Wilfred Hughes Date: Sat, 7 Oct 2023 14:41:28 -0700 Look for "function" or "variable" text in doc comments case-insensitively Fixes #326

Remove broken tokei LOC badge

2023-10-07T17:53:51Z

commit 2b50adfd7a33a1c3f8d68f06d50d779459956ada parent 66ba816b26b68dd7df08e86f8b96eaae16c8d6a2 Author: Wilfred Hughes Date: Sat, 7 Oct 2023 10:53:51 -0700 Remove broken tokei LOC badge

fix nil pos when building button for vars

2023-09-09T23:36:58Z

commit 66ba816b26b68dd7df08e86f8b96eaae16c8d6a2 parent c57ff0d284b50ff430fe1f13fd48deaa0d1a910e Author: Jimmy Yuen Ho Wong Date: Sun, 10 Sep 2023 00:36:58 +0100 fix nil pos when building button for vars

Enable outline-support for Emacs 29

2023-08-04T20:15:25Z

commit c57ff0d284b50ff430fe1f13fd48deaa0d1a910e parent 56af42b634d1c748eb4e4a03fcbd34a4c9dfaf79 Author: Rahguzar Date: Fri, 4 Aug 2023 22:15:25 +0200 Enable outline-support for Emacs 29

Mark customizable variables (user options) in the summary line

2023-01-07T09:28:05Z

commit 56af42b634d1c748eb4e4a03fcbd34a4c9dfaf79 parent 69f2bc0609f8017341b7c868f7ca27a00485bf3d Author: Kisaragi Hiu Date: Sat, 7 Jan 2023 18:28:05 +0900 Mark customizable variables (user options) in the summary line User options are variables declared with defcustom. It is useful to know if a variable is a user option or not, because if it isn't, it's usually not safe to set it in the init file. Calling user options "customizable variables" makes it clear that a user option is still a variable. This is kind of like how interactive functions are not referred to as "commands" in the summary.

Support describing faces using `helpful-symbol`.

2023-06-10T10:51:20Z

commit 69f2bc0609f8017341b7c868f7ca27a00485bf3d parent acb3e335c7e1d52ac4887ff96f05b08dabf3a646 Author: yuhan0 Date: Sat, 10 Jun 2023 18:51:20 +0800 Support describing faces using `helpful-symbol`. Uses the native `describe-face`, possible to switch to a `helpful-face` command if implemented in the future.

Improve user-friendliness of disambiguation prompt

2023-06-10T10:49:41Z

commit acb3e335c7e1d52ac4887ff96f05b08dabf3a646 parent 6f8991a72c83d904725a9d6c00de2cabbef32de9 Author: yuhan0 Date: Sat, 10 Jun 2023 18:49:41 +0800 Improve user-friendliness of disambiguation prompt Uses read-char-choice for selecting between callable (press "c") and variable (press "v") when the symbol is ambiguous, eg. `buffer-file-name'. Less mental effort required than parsing a y-or-n-p prompt and answering in the negative to "show variable?" to show help for a function.

Roll version for 0.22

2023-07-30T17:32:09Z

commit 6f8991a72c83d904725a9d6c00de2cabbef32de9 parent ced07fe0d48ce1111d7a8376fdbfef34d927c967 Author: Wilfred Hughes Date: Sun, 30 Jul 2023 10:32:09 -0700 Roll version for 0.22 I accidentally released 0.20 on an older checkout, so 0.21 has been released today too.

Update changelog for 0.21

2023-07-30T17:31:08Z

commit ced07fe0d48ce1111d7a8376fdbfef34d927c967 parent c2920e8dddc6271ea6fd132184a639dde995a3fa Author: Wilfred Hughes Date: Sun, 30 Jul 2023 10:31:08 -0700 Update changelog for 0.21 Looks like I should have pulled before tagging a release

0.20 has been released, roll version

2023-07-30T17:27:47Z

commit c2920e8dddc6271ea6fd132184a639dde995a3fa parent 32cb28b50b3366ad35e2cb936367268ddeec745f Author: Wilfred Hughes Date: Sun, 30 Jul 2023 10:27:47 -0700 0.20 has been released, roll version Fixes #327

helpful--heading: propertize newline as well, enabling `:extend t`

2023-05-03T18:16:28Z

commit 32cb28b50b3366ad35e2cb936367268ddeec745f parent 8893e4ba49e4447b41ee08d93e58c23e07bc7514 Author: Mekeor Melire Date: Wed, 3 May 2023 20:16:28 +0200 helpful--heading: propertize newline as well, enabling `:extend t` Prior to this commit, setting attribute :extend of the face helpful--heading to t did not take any effect. This is fixed by this commit by propertizing the newline right after the heading as well.

suppress some compiler warnings

2023-04-18T00:06:18Z

commit 8893e4ba49e4447b41ee08d93e58c23e07bc7514 parent e9ec6fc2ae10db2b9b59ed656021845d11881a0a Author: Lucius Hu Date: Mon, 17 Apr 2023 20:06:18 -0400 suppress some compiler warnings

Remap `revert-buffer` and `revert-buffer-quick` to `helpful-update`.

2023-03-11T00:20:37Z

commit e9ec6fc2ae10db2b9b59ed656021845d11881a0a parent 1c98f6f06a85def5d34c735f8cd407f20cebddf9 Author: okamsn Date: Fri, 10 Mar 2023 19:20:37 -0500 Remap `revert-buffer` and `revert-buffer-quick` to `helpful-update`.

`C-h x` for commands (standard binding)

2022-12-22T09:18:41Z

commit 1c98f6f06a85def5d34c735f8cd407f20cebddf9 parent 94c25337b2de2f9da60914a7c0c6cca9584c0231 Author: Hraban Luyat Date: Thu, 22 Dec 2022 09:18:41 +0000 `C-h x` for commands (standard binding) The standard Emacs binding for help with commands is `C-h x`, no need to shadow `C-h C`.

Use help-key-binding as face for keystrokes

2022-12-09T08:45:57Z

commit 94c25337b2de2f9da60914a7c0c6cca9584c0231 parent 4a8d5765c97bdd3103cc921d740b93bf3fc1c162 Author: Nacho Barrientos Date: Fri, 9 Dec 2022 09:45:57 +0100 Use help-key-binding as face for keystrokes

Update changelog

2022-12-01T17:20:50Z

commit 4a8d5765c97bdd3103cc921d740b93bf3fc1c162 parent 2f525ca6e49a869cf315ae48851e511bad42a975 Author: Wilfred Hughes Date: Thu, 1 Dec 2022 09:20:50 -0800 Update changelog

Add support for following and storing org "help" links

2022-11-01T13:44:01Z

commit 2f525ca6e49a869cf315ae48851e511bad42a975 parent 08507233ba5a8335a3646f14eb3f42526b8389d2 Author: Damien Cassou Date: Tue, 1 Nov 2022 14:44:01 +0100 Add support for following and storing org "help" links Closes #38

Test again Emacs 28 and drop CI for 25/26

2022-12-01T17:16:48Z

commit 08507233ba5a8335a3646f14eb3f42526b8389d2 parent dc4e356b55212f67c7022f3aec4f5986a23d5d5e Author: Wilfred Hughes Date: Thu, 1 Dec 2022 09:16:48 -0800 Test again Emacs 28 and drop CI for 25/26

Remove use of (point) as a generalized variable

2022-11-04T14:07:00Z

commit dc4e356b55212f67c7022f3aec4f5986a23d5d5e parent 60c1cd49f72e930b8796e5644bd222e8fc466740 Author: ksqsf Date: Fri, 4 Nov 2022 22:07:00 +0800 Remove use of (point) as a generalized variable This use has been made obsolete since Emacs 29.

Mark symbol in "the command " as callable

2022-10-20T08:55:54Z

commit 60c1cd49f72e930b8796e5644bd222e8fc466740 parent 3aa08da7a151f1928bf0e3d12fc2443b6485b6ef Author: Kisaragi Hiu Date: Thu, 20 Oct 2022 17:55:54 +0900 Mark symbol in "the command " as callable This, for example, skips an unnecessary "show variable?" for local minor mode variables. Whereas recentf-mode (global) says: > Non-nil if Recentf mode is enabled. > > See the recentf-mode command > for a description of this minor mode. , whitespace-mode (local) says: > Non-nil if Whitespace mode is enabled. > > Use the command whitespace-mode to change this variable. . This change catches the latter case.

Ignore comments when narrowing to defun

2022-09-25T22:06:36Z

commit 3aa08da7a151f1928bf0e3d12fc2443b6485b6ef parent db1e15b3783c83d9781a546f37b900ad53576659 Author: Wilfred Hughes Date: Sun, 25 Sep 2022 15:06:36 -0700 Ignore comments when narrowing to defun Closes #287

Don't activate a major mode in throwaway buffers

2022-09-19T05:40:59Z

commit db1e15b3783c83d9781a546f37b900ad53576659 parent a9c729cb248b7863685f04e418d9c0c0a600df0d Author: Wilfred Hughes Date: Sun, 18 Sep 2022 22:40:59 -0700 Don't activate a major mode in throwaway buffers This can be slow, even with major mode hooks disabled. Minor mode hooks may do non-trivial amounts of work. Instead, just set the syntax table, so we can search the buffer for definitions accurately. Fixes #287

Remove unused variable

2022-09-19T05:09:49Z

commit a9c729cb248b7863685f04e418d9c0c0a600df0d parent 6a65259feb8bc7a763ad8213bec19d2105e6cf0b Author: Wilfred Hughes Date: Sun, 18 Sep 2022 22:09:49 -0700 Remove unused variable

Preserve point when finding variables defined in an open buffer

2022-09-19T05:06:13Z

commit 6a65259feb8bc7a763ad8213bec19d2105e6cf0b parent cf6bc8badd8bebd6e0ffc9881751cefd86d11dcd Author: Wilfred Hughes Date: Sun, 18 Sep 2022 22:06:13 -0700 Preserve point when finding variables defined in an open buffer Fixes #301

Factor out a helper for opening buffers if needed

2022-09-19T04:43:34Z

commit cf6bc8badd8bebd6e0ffc9881751cefd86d11dcd parent 6633d82c6e3c921c486ec284cb6542f33278b605 Author: Wilfred Hughes Date: Sun, 18 Sep 2022 21:43:34 -0700 Factor out a helper for opening buffers if needed

Assign `list-buffers-directory` to help topic

2021-07-06T18:29:38Z

commit 6633d82c6e3c921c486ec284cb6542f33278b605 parent cb9beb0bd6857d9262c935e42a9346331cee4c45 Author: Daniel Nagy Date: Tue, 6 Jul 2021 20:29:38 +0200 Assign `list-buffers-directory` to help topic This displays the help topic in `M-x list-buffers` instead of showing an empty path column.

Unescape \= in signature docstring

2021-03-15T11:02:04Z

commit cb9beb0bd6857d9262c935e42a9346331cee4c45 parent 94a07d49a80f66f8ebc54a49a4b4f6899a65fbe3 Author: Nikita Bloshchanevich Date: Mon, 15 Mar 2021 12:02:04 +0100 Unescape \= in signature docstring `helpful--signature': unquote \=, as added by `help--quote-signature'. An example where this is needed is `\(setf\ seq-first\)'.

Fix advised native-compiled function being treated as primitives

2022-05-30T00:22:03Z

commit 94a07d49a80f66f8ebc54a49a4b4f6899a65fbe3 parent 209971ba9f576ba080352642cfbf25df5692b1d7 Author: Kisaragi Hiu Date: Mon, 30 May 2022 09:22:03 +0900 Fix advised native-compiled function being treated as primitives In Emacs 28, subrp is t for a native-compiled function; to check whether a function is a primitive, there is a new function subr-primitive-p. Previously, unadvised functions have an extra check that does the same thing as subr-primitive-p, but that was not applied to advised functions. This applies it to both.

Check for emacs version in helpful--docstring test

2022-05-28T03:10:33Z

commit 209971ba9f576ba080352642cfbf25df5692b1d7 parent 741b8641657578926444a80657fb36c3d8c5372d Author: Erik Šabič Date: Sat, 28 May 2022 05:10:33 +0200 Check for emacs version in helpful--docstring test

Fix advised function docstring test

2022-05-27T17:28:30Z

commit 741b8641657578926444a80657fb36c3d8c5372d parent 2f91e7992dae078a9cbc0d7f8e603e02d0abfcb0 Author: Erik Šabič Date: Fri, 27 May 2022 19:28:30 +0200 Fix advised function docstring test

Roll version

2022-05-13T02:58:01Z

commit 2f91e7992dae078a9cbc0d7f8e603e02d0abfcb0 parent c2729a236a84a1fbd3d184c163fbd10e0fd62077 Author: Wilfred Hughes Date: Thu, 12 May 2022 22:58:01 -0400 Roll version

Add buttons for shortdoc groups when shortdoc.el is available

2022-04-07T21:56:31Z

commit c2729a236a84a1fbd3d184c163fbd10e0fd62077 parent 67cdd1030b3022d3dc4da2297f55349da57cde01 Author: Kisaragi Hiu Date: Fri, 8 Apr 2022 06:56:31 +0900 Add buttons for shortdoc groups when shortdoc.el is available Emacs 28 added shortdoc.el and added many builtin functions into shortdoc groups accessed through the help buffer. For example, this is the help buffer for `mapcar`: Apply FUNCTION to each element of SEQUENCE, and make a list of the results. The result is a list just as long as SEQUENCE. SEQUENCE may be a list, a vector, a bool-vector, or a string. Other relevant functions are documented in the vector, list and string groups. Probably introduced at or before Emacs version 1.4. This commit adds the same line into Helpful so it looks like this: Signature (mapcar FUNCTION SEQUENCE) Documentation Apply FUNCTION to each element of SEQUENCE, and make a list of the results. The result is a list just as long as SEQUENCE. SEQUENCE may be a list, a vector, a bool-vector, or a string. Other relevant functions are documented in the vector, list and string groups. View in manual

Fix `helpful--autoloaded-p` in Emacs 29.0.50 (#283)

2022-02-20T23:08:08Z

commit 67cdd1030b3022d3dc4da2297f55349da57cde01 parent f865f17ad04cd270685187b0a5331ec8eb06e541 Author: Adrià Garriga-Alonso Date: Sun, 20 Feb 2022 23:08:08 +0000 Fix `helpful--autoloaded-p` in Emacs 29.0.50 (#283) Fix `helpful--autoloaded-p` in Emacs 29.0.50

Update buffers before switching to them.

2021-10-02T22:02:02Z

commit f865f17ad04cd270685187b0a5331ec8eb06e541 parent 2afbde902742b1aa64daa31a635ba564f14b35ae Author: Roshan Shariff Date: Sat, 2 Oct 2021 16:02:02 -0600 Update buffers before switching to them. Calls `helpful-update` in the help buffer before switching to it with `helpful-switch-buffer-function`. Currently, this is done in the opposite order. Switching to an empty buffer prevents window resize logic from working properly. For example, it makes the window too small when the `window-height` action alist key is set to `#'shrink-window-if-larger-than-buffer` or `#'fit-window-to-buffer` in `display-buffer-alist`.

Use lexical-binding in tests and fix crash exposed

2021-12-11T07:03:15Z

commit 2afbde902742b1aa64daa31a635ba564f14b35ae parent dd806b8f04bcaca725a481b0b4a9bda384e570a6 Author: Wilfred Hughes Date: Fri, 10 Dec 2021 23:03:15 -0800 Use lexical-binding in tests and fix crash exposed argdesc in byte-code function objects may be an integer rather than a list, so handle that case gracefully.

Fix warnings on unused vars in test suite

2021-12-11T06:49:12Z

commit dd806b8f04bcaca725a481b0b4a9bda384e570a6 parent 4f4d14028f38b1dde3d5821b6f5ea39cabae1030 Author: Wilfred Hughes Date: Fri, 10 Dec 2021 22:49:12 -0800 Fix warnings on unused vars in test suite

Use well-formed interactive lambdas to silence a warning

2021-12-11T06:45:50Z

commit 4f4d14028f38b1dde3d5821b6f5ea39cabae1030 parent a27eed0359c7a059e53a726f9e4d18ea94e932d2 Author: Wilfred Hughes Date: Fri, 10 Dec 2021 22:45:50 -0800 Use well-formed interactive lambdas to silence a warning

Don't offer 'find all references' for anonymous lambdas

2021-12-11T06:14:19Z

commit a27eed0359c7a059e53a726f9e4d18ea94e932d2 parent 55a8ebcd644bedf7330ac6c744ca66a48fea01b1 Author: Wilfred Hughes Date: Fri, 10 Dec 2021 22:14:19 -0800 Don't offer 'find all references' for anonymous lambdas

Fix crash on lambdas with docstrings

2021-12-11T06:09:39Z

commit 55a8ebcd644bedf7330ac6c744ca66a48fea01b1 parent 217b38398bfa523c48f630b06b21427974d93e1d Author: Wilfred Hughes Date: Fri, 10 Dec 2021 22:09:39 -0800 Fix crash on lambdas with docstrings Spotted when debugging #278.

Rewrite helpful--tree-any-p as a loop

2021-12-11T05:38:58Z

commit 217b38398bfa523c48f630b06b21427974d93e1d parent 8df39c15d290cd499ef261de868191d3fc84f75a Author: Wilfred Hughes Date: Fri, 10 Dec 2021 21:38:58 -0800 Rewrite helpful--tree-any-p as a loop Fixes #279

Change "compiled" to "byte-compiled"

2021-08-22T13:37:23Z

commit 8df39c15d290cd499ef261de868191d3fc84f75a parent 7e4b1f0d5572a4e2b8ee7a9b084ef863d0315a73 Author: Daniel Nagy Date: Sun, 22 Aug 2021 15:37:23 +0200 Change "compiled" to "byte-compiled" With the introduction of native compilation, this change makes the distinction between it and byte-compilation clearer. https://akrl.sdf.org/gccemacs.html

Prevent error in helpful-variable if sexp at point can't be read

2021-02-02T16:54:44Z

commit 7e4b1f0d5572a4e2b8ee7a9b084ef863d0315a73 parent 716c116d6a9fafb16a5b1e6be5dbd8e82f357c7e Author: Dario Gjorgjevski Date: Tue, 2 Feb 2021 17:54:44 +0100 Prevent error in helpful-variable if sexp at point can't be read How to reproduce from emacs -Q in the *scratch* buffer: 0. If needed, do `(package-initialize)` and `(require 'helpful)`. 1. Type `(something some-undefined-variable|` where | represents point. (Note that there is no closing parenthesis!) 2. Call helpful-variable. This will give you an `End of file during parsing` from `helpful--variable-defined-at-point` because the sexp at point can't be read due to the missing parenthesis. This commit suppresses the error Fix #251 Close #254

Merge pull request #266 from nbfalcon/bugfix/keyboard-macro-space-dot

2021-03-19T07:49:48Z

commit 716c116d6a9fafb16a5b1e6be5dbd8e82f357c7e parent 88e53d3267e8168e056e96989e9cc8fb50d33c50 Author: Wilfred Hughes Date: Fri, 19 Mar 2021 00:49:48 -0700 Merge pull request #266 from nbfalcon/bugfix/keyboard-macro-space-dot Keyboard macros: fix space before "."

Keyboard macros: fix space before "."

2021-03-14T12:12:13Z

commit 79533a18c4a134806150ce5a0e45d0ad55238584 parent 88e53d3267e8168e056e96989e9cc8fb50d33c50 Author: Nikita Bloshchanevich Date: Sun, 14 Mar 2021 13:12:13 +0100 Keyboard macros: fix space before "."

Tweak UI wording

2021-03-07T02:06:29Z

commit 88e53d3267e8168e056e96989e9cc8fb50d33c50 parent 91aa5460c648493a87644b7e77e1cb90f1556c9f Author: Wilfred Hughes Date: Sat, 6 Mar 2021 18:06:29 -0800 Tweak UI wording

Capitalise package description to match emacs convention

2021-03-06T19:55:57Z

commit 91aa5460c648493a87644b7e77e1cb90f1556c9f parent 0b6720145e1d1e037ec8658b83fddfad2c0ce923 Author: Wilfred Hughes Date: Sat, 6 Mar 2021 11:55:57 -0800 Capitalise package description to match emacs convention

Merge pull request #259 from jcs-PR/df

2021-02-19T07:28:00Z

commit 0b6720145e1d1e037ec8658b83fddfad2c0ce923 parent afb2ccc0d71f233918b1ccd027af5023637654f4 Author: Wilfred Hughes Date: Thu, 18 Feb 2021 23:28:00 -0800 Merge pull request #259 from jcs-PR/df Remove dash-functional as dependency

Remove dash-function as dependency:

2021-02-17T14:18:13Z

commit d43011476d0c6bf560d55d197b0cf1ed4374e4e6 parent afb2ccc0d71f233918b1ccd027af5023637654f4 Author: JenChieh Date: Wed, 17 Feb 2021 22:18:13 +0800 Remove dash-function as dependency:

Merge pull request #257 from iwahbe/fix-circular-structure-pprint

2021-02-15T03:26:57Z

commit afb2ccc0d71f233918b1ccd027af5023637654f4 parent c70db01c19dfc88a7781eb841bcace148617814f Author: Wilfred Hughes Date: Sun, 14 Feb 2021 19:26:57 -0800 Merge pull request #257 from iwahbe/fix-circular-structure-pprint Fix helpful--pretty-print on circular structures

Remove travis configuration

2021-02-15T03:25:09Z

commit c70db01c19dfc88a7781eb841bcace148617814f parent d58b9381873230f588b060a6f0eba6437c54794c Author: Wilfred Hughes Date: Sun, 14 Feb 2021 19:25:09 -0800 Remove travis configuration

Download emacs source during tests, and split steps

2021-02-15T03:20:27Z

commit d58b9381873230f588b060a6f0eba6437c54794c parent 366057cda8a587b8bf1261612c62306c15751fde Author: Wilfred Hughes Date: Sun, 14 Feb 2021 19:20:27 -0800 Download emacs source during tests, and split steps

Set up tests on GitHub actions

2021-02-15T03:12:21Z

commit 366057cda8a587b8bf1261612c62306c15751fde parent 584ecc887bb92133119f93a6716cdf7af0b51dca Author: Wilfred Hughes Date: Sun, 14 Feb 2021 19:12:21 -0800 Set up tests on GitHub actions

Fix helpful--pretty-print on circular structures

2021-02-12T19:42:18Z

commit b696b9fa6ed3f3df8cc3918347bd3eaa05a645f5 parent 584ecc887bb92133119f93a6716cdf7af0b51dca Author: Ian Wahbe Date: Fri, 12 Feb 2021 11:42:18 -0800 Fix helpful--pretty-print on circular structures

Fix hang on autoload functions with advice

2020-10-12T06:14:42Z

commit 584ecc887bb92133119f93a6716cdf7af0b51dca parent dc40546747624ad86944177ebaa9fb30f9b70705 Author: Wilfred Hughes Date: Sun, 11 Oct 2020 23:14:42 -0700 Fix hang on autoload functions with advice Fixes #179. Fixes #191.

Correct docstring on predicate helper

2020-10-12T04:50:26Z

commit dc40546747624ad86944177ebaa9fb30f9b70705 parent 1671e1dd08ca9543bf80e878135c6bbba84efe05 Author: Wilfred Hughes Date: Sun, 11 Oct 2020 21:50:26 -0700 Correct docstring on predicate helper

Roll version

2020-09-30T23:12:40Z

commit 1671e1dd08ca9543bf80e878135c6bbba84efe05 parent 5a5eb62ae1f9cfdd4897ec6e878ec96231c52bdd Author: Wilfred Hughes Date: Wed, 30 Sep 2020 16:12:40 -0700 Roll version

Choose the default symbol more intelligently

2020-09-23T07:05:14Z

commit 5a5eb62ae1f9cfdd4897ec6e878ec96231c52bdd parent f4b838c1080174e05a9e5f8672c4510a6d8298dc Author: Wilfred Hughes Date: Wed, 23 Sep 2020 00:05:14 -0700 Choose the default symbol more intelligently Fixes #163 Closes #245 Particular thanks to @matzebond for the first implementation of this feature!

Cross-reference the different functions for callables

2020-09-30T22:07:47Z

commit f4b838c1080174e05a9e5f8672c4510a6d8298dc parent 27373703625fdf86fe0f71500767802a28350b9f Author: Wilfred Hughes Date: Wed, 30 Sep 2020 15:07:47 -0700 Cross-reference the different functions for callables

Detect docstring symbol references that are unambiguous

2020-09-23T06:18:34Z

commit 27373703625fdf86fe0f71500767802a28350b9f parent b0e937fff71dc0a5d34066bfd25310e76f284621 Author: Wilfred Hughes Date: Tue, 22 Sep 2020 23:18:34 -0700 Detect docstring symbol references that are unambiguous If we see "function `foo'" or "variable `foo'", it's clear what we should link to. Fixes #243

Fix docstring extraction in Emacs 27

2020-09-18T06:35:58Z

commit b0e937fff71dc0a5d34066bfd25310e76f284621 parent c0662aa07266fe204f4e6d72ccaa6af089400556 Author: Wilfred Hughes Date: Thu, 17 Sep 2020 23:35:58 -0700 Fix docstring extraction in Emacs 27 Fixes #248

Merge pull request #240 from xeals/master

2020-05-06T08:16:42Z

commit c0662aa07266fe204f4e6d72ccaa6af089400556 parent c54e9ddbd6a77858048c1a4c4b549de98af8f88e Author: Wilfred Hughes Date: Wed, 6 May 2020 01:16:42 -0700 Merge pull request #240 from xeals/master Add support for natively-compiled functions

Add "natively compiled" info to summary

2020-05-04T13:31:41Z

commit 10943c3593901d6891ecf2350bc7eed4d560e146 parent 3a9ada2b46264e271923b7dbcbc219f2e360bc22 Author: xeals Date: Mon, 4 May 2020 23:31:41 +1000 Add "natively compiled" info to summary

Check callables aren't native-compiled before calling them primitive

2020-05-04T12:56:36Z

commit 3a9ada2b46264e271923b7dbcbc219f2e360bc22 parent c54e9ddbd6a77858048c1a4c4b549de98af8f88e Author: xeals Date: Mon, 4 May 2020 22:56:36 +1000 Check callables aren't native-compiled before calling them primitive

Disable test that fails when we byte-compile

2020-02-02T23:12:22Z

commit c54e9ddbd6a77858048c1a4c4b549de98af8f88e parent e511e8dbd32a8b8423f07178f0ea7c1ecfc63935 Author: Wilfred Hughes Date: Sun, 2 Feb 2020 23:12:22 +0000 Disable test that fails when we byte-compile Fixes #225

Add support for CL generic methods

2019-11-29T16:33:15Z

commit e511e8dbd32a8b8423f07178f0ea7c1ecfc63935 parent 982dd49c9c7e63fa94b56824f50dea4186081f8e Author: Damien Cassou Date: Fri, 29 Nov 2019 17:33:15 +0100 Add support for CL generic methods

Improve link creation from Info manual references

2019-12-30T12:11:57Z

commit 982dd49c9c7e63fa94b56824f50dea4186081f8e parent edddccbebd82dde0a18662a0995bfe930112458c Author: Daniel Martín Date: Mon, 30 Dec 2019 13:11:57 +0100 Improve link creation from Info manual references * helpful.el (helpful--propertize-info): Follow Emacs convention for function documentation. Consider lowercase "info" and angular quotation marks in docstrings. Default to the Emacs manual if there's no manual reference (ie. see the `blink-cursor-mode' variable). * test/helpful-unit-test.el (helpful--format-docstring--info): Add new testcases for the now covered cases.

Fix typos

2019-11-26T19:50:39Z

commit edddccbebd82dde0a18662a0995bfe930112458c parent e2609e4ae9e058bd8be6239681b2f22195628f28 Author: Damien Cassou Date: Tue, 26 Nov 2019 20:50:39 +0100 Fix typos Typos found with codespell.

Handle byte-compiled functions bound to keys

2019-10-01T00:09:06Z

commit e2609e4ae9e058bd8be6239681b2f22195628f28 parent 3b0f42e77d05cf38a90a34dca76600df800d02b7 Author: Wilfred Hughes Date: Tue, 1 Oct 2019 01:09:06 +0100 Handle byte-compiled functions bound to keys Fixes #212

Adding TODO

2019-09-30T23:57:24Z

commit 3b0f42e77d05cf38a90a34dca76600df800d02b7 parent e9e958a5643619d0e32b9934bf4e9195c57cb71f Author: Wilfred Hughes Date: Tue, 1 Oct 2019 00:57:24 +0100 Adding TODO

Ensure ? in symbols isn't needlessly escaped

2019-08-13T18:36:28Z

commit e9e958a5643619d0e32b9934bf4e9195c57cb71f parent e3d8ee7fe4219d4172c3c9c0eddd4f3f9f051061 Author: Wilfred Hughes Date: Tue, 13 Aug 2019 19:36:28 +0100 Ensure ? in symbols isn't needlessly escaped

Use "and" in summaries

2019-08-13T18:21:09Z

commit e3d8ee7fe4219d4172c3c9c0eddd4f3f9f051061 parent 69474e9c49076ce82cea4eff237933b6cec0b5cf Author: Wilfred Hughes Date: Tue, 13 Aug 2019 19:21:09 +0100 Use "and" in summaries For example, say "ace-window is an autoloaded, interactive and compiled function" rather than comma-separating everywhere. Also simplify button logic and add a test for "an" in descriptions.

Fix helpful--convert-c-name calls

2019-07-11T23:19:29Z

commit 69474e9c49076ce82cea4eff237933b6cec0b5cf parent 802bc8b7836c3c99f591dda1d56cf6d4016812bd Author: Nick Drozd Date: Thu, 11 Jul 2019 18:19:29 -0500 Fix helpful--convert-c-name calls I don't know how these got mixed up, but they did.

Use trusty to fix Emacs 26.x

2019-08-06T23:39:53Z

commit 802bc8b7836c3c99f591dda1d56cf6d4016812bd parent 8ac851e7c0f8345046d053d136befe28fd75dcd9 Author: Wilfred Hughes Date: Wed, 7 Aug 2019 00:39:53 +0100 Use trusty to fix Emacs 26.x

Remove another used function

2019-07-23T23:48:26Z

commit 8ac851e7c0f8345046d053d136befe28fd75dcd9 parent 7105f47d22b9966cfa5dc6614449e7407abba539 Author: Wilfred Hughes Date: Wed, 24 Jul 2019 00:48:26 +0100 Remove another used function Found with M-x emr-el-find-unused-definitions

Remove unused function

2019-07-23T23:47:32Z

commit 7105f47d22b9966cfa5dc6614449e7407abba539 parent 00c5c696521dd361e540af8a1fb5c529527ab5cb Author: Wilfred Hughes Date: Wed, 24 Jul 2019 00:47:32 +0100 Remove unused function Fixes #210

Report package/emacs version for custom variables

2019-07-23T23:39:22Z

commit 00c5c696521dd361e540af8a1fb5c529527ab5cb parent 866d5daecb168c0b62c91ccf5dec833d5cdcac5c Author: Wilfred Hughes Date: Wed, 24 Jul 2019 00:39:22 +0100 Report package/emacs version for custom variables Fixes #207

Show the original value for defcustom variables

2019-07-10T23:56:22Z

commit 866d5daecb168c0b62c91ccf5dec833d5cdcac5c parent ddd1f2c6794972e16393614716532fc1753edd31 Author: Wilfred Hughes Date: Thu, 11 Jul 2019 00:56:22 +0100 Show the original value for defcustom variables Fixes #199

Roll version

2019-07-10T23:15:54Z

commit ddd1f2c6794972e16393614716532fc1753edd31 parent 429f1fb5f588cc6124513335e8eca3b4ef15735a Author: Wilfred Hughes Date: Thu, 11 Jul 2019 00:15:54 +0100 Roll version

Add bookmark support

2019-07-10T23:14:43Z

commit 429f1fb5f588cc6124513335e8eca3b4ef15735a parent 0aa289e7a954df456793e7bc1f4bdc3d072e783f Author: Wilfred Hughes Date: Thu, 11 Jul 2019 00:14:43 +0100 Add bookmark support Fixes #203

Show how to configure Helpful with counsel

2019-07-10T22:49:39Z

commit 0aa289e7a954df456793e7bc1f4bdc3d072e783f parent 9bad49aad8b202a5c19b71e98f40e0b81f2bb16f Author: Wilfred Hughes Date: Wed, 10 Jul 2019 23:49:39 +0100 Show how to configure Helpful with counsel See discussion in #156

Test in Emacs 26.2, and test both before and after compilation

2019-06-22T18:56:25Z

commit 9bad49aad8b202a5c19b71e98f40e0b81f2bb16f parent b0cd36e8f0caaddeacb3933e6111842b6560d9c9 Author: Wilfred Hughes Date: Sat, 22 Jun 2019 19:56:25 +0100 Test in Emacs 26.2, and test both before and after compilation

Show if a function is compiled

2019-03-12T21:36:08Z

commit b0cd36e8f0caaddeacb3933e6111842b6560d9c9 parent 9a552f0c7c20eefae09a9283be98d56dc3e20fd8 Author: Erik Arvstedt Date: Tue, 12 Mar 2019 22:36:08 +0100 Show if a function is compiled Include this info like in `describe-function`

Relax minimum Emacs version

2019-06-20T21:18:29Z

commit 9a552f0c7c20eefae09a9283be98d56dc3e20fd8 parent 897feba75ded5c93dcfc3d950319cf19c03252db Author: Wilfred Hughes Date: Thu, 20 Jun 2019 22:18:29 +0100 Relax minimum Emacs version Helpful relies on several 24.x Emacs features (defvar-local, nadvice, lexical binding), but the only 25.x feature is macroexpand-1. `M-x package-lint-current-buffer` is happy with this change. Fixes #205

Do not require shut-up package

2018-12-27T13:19:39Z

commit 897feba75ded5c93dcfc3d950319cf19c03252db parent f61d0a060ad54bdf0c305afe1e362518f64463dd Author: Jonas Bernoulli Date: Thu, 27 Dec 2018 14:19:39 +0100 Do not require shut-up package

Disable major mode change hooks when finding definitions

2019-05-16T19:54:56Z

commit f61d0a060ad54bdf0c305afe1e362518f64463dd parent 53ae44bd2384de5e2513496ccf6ca2fce6767299 Author: Wilfred Hughes Date: Thu, 16 May 2019 20:54:56 +0100 Disable major mode change hooks when finding definitions Fixes #208

Prefer displaying string values as literals

2019-04-07T22:35:26Z

commit 53ae44bd2384de5e2513496ccf6ca2fce6767299 parent 9d8e7f3c3a44ac0f2bc7b0438c31226481476aff Author: Wilfred Hughes Date: Sun, 7 Apr 2019 23:35:26 +0100 Prefer displaying string values as literals Fixes #200

Don't show the Source Code heading if we don't have any source

2019-04-07T20:54:23Z

commit 9d8e7f3c3a44ac0f2bc7b0438c31226481476aff parent 67b7592f970776776d243cacf7363eb93bc28ebc Author: Wilfred Hughes Date: Sun, 7 Apr 2019 21:54:23 +0100 Don't show the Source Code heading if we don't have any source

Render keyboard maros in keymap pretty view

2019-04-07T20:43:02Z

commit 67b7592f970776776d243cacf7363eb93bc28ebc parent 0a83a7b028881a7a463ba5dfc7646ca98afc48c7 Author: Wilfred Hughes Date: Sun, 7 Apr 2019 21:43:02 +0100 Render keyboard maros in keymap pretty view Fixes #202

Ensure backslashes in string literals are escaped

2019-03-16T16:56:36Z

commit 0a83a7b028881a7a463ba5dfc7646ca98afc48c7 parent ade085ac805845f70d5b46acca552071f42782cb Author: Wilfred Hughes Date: Sat, 16 Mar 2019 16:56:36 +0000 Ensure backslashes in string literals are escaped Fixes #197