summaryrefslogtreecommitdiff
path: root/lisp/emacs-lisp/shortdoc.el
Commit message (Collapse)AuthorAgeFilesLines
* Minor shortdoc link improvementsDaniel Martín2021-01-101-2/+11
| | | | | | | | | | * lisp/emacs-lisp/shortdoc.el (shortdoc--display-function): Use describe-function as a fallback link when a function is not documented in any Info manual. Also make the link respond to mouse-1, like the rest of *Help* links, and add a proper help-echo property. * lisp/help-fns.el (help-fns--mention-shortdoc-groups): Same link improvement as described before, this time for the shortdoc groups (bug#45750).
* Update copyright year to 2021Paul Eggert2021-01-011-1/+1
| | | | Run "TZ=UTC0 admin/update-copyright".
* ; Fix recent shortdoc.el and fns.c additionsBasil L. Contovounesios2020-12-271-3/+3
| | | | | * lisp/emacs-lisp/shortdoc.el (list): Fix typos. * src/fns.c (Flength_equal): Fix docstring.
* Add new predicates for sequence lengthsLars Ingebrigtsen2020-12-271-0/+6
| | | | | | | | | | | | | * doc/lispref/sequences.texi (Sequence Functions): Document them. * lisp/emacs-lisp/byte-opt.el (side-effect-free-fns): Mark them as side-effect-free. * lisp/emacs-lisp/shortdoc.el (list): Mention them. * src/fns.c (Flength): Mention them in the doc string. (length_internal): New function. (Flength_less, Flength_greater, Flength_equal): New defuns. (syms_of_fns): Sym them.
* Allow `string-limit' to work on encoded stringsLars Ingebrigtsen2020-12-251-1/+2
| | | | | | | * doc/lispref/strings.texi (Creating Strings): Document it. * lisp/emacs-lisp/subr-x.el (string-limit): Allow limiting on encoded strings.
* Remove `string-slice' -- it's not very well definedLars Ingebrigtsen2020-12-251-3/+0
| | | | | | * doc/lispref/strings.texi (Creating Strings): Ditto. * lisp/emacs-lisp/subr-x.el (string-slice): Remove.
* Improve the string-limit doc stringLars Ingebrigtsen2020-12-231-0/+3
| | | | | * lisp/emacs-lisp/subr-x.el (string-limit): Mention truncate-string-to-width in the doc string.
* Make string-pad take an optional START parameterLars Ingebrigtsen2020-12-221-1/+1
| | | | | * lisp/emacs-lisp/subr-x.el (string-pad): Alter the calling convention.
* Change the string-limit parameter semanticsLars Ingebrigtsen2020-12-221-1/+1
| | | | | * lisp/emacs-lisp/subr-x.el (string-limit): Alter the calling convention.
* Add try-completion to the string shortdocLars Ingebrigtsen2020-12-211-0/+2
| | | | * lisp/emacs-lisp/shortdoc.el (string): Mention try-completion here.
* Add string-chop-newlineLars Ingebrigtsen2020-12-211-0/+2
| | | | | * doc/lispref/strings.texi (Creating Strings): Document it. * lisp/emacs-lisp/subr-x.el (string-chop-newline): Add new function.
* Rename slice-string to string-sliceLars Ingebrigtsen2020-12-211-3/+3
| | | | | * lisp/emacs-lisp/subr-x.el (string-slice): Rename from slice-string. * doc/lispref/strings.texi (Creating Strings): Ditto.
* Add `string-pad'Lars Ingebrigtsen2020-12-211-0/+4
| | | | | | | * doc/lispref/strings.texi (Creating Strings): Document it. * lisp/emacs-lisp/shortdoc.el (string): Add example. * lisp/emacs-lisp/subr-x.el (string-pad): New function.
* Beef up the Emacs string utility set a bitLars Ingebrigtsen2020-12-211-0/+15
| | | | | | | | | * doc/lispref/strings.texi (Modifying Strings): Document them. * lisp/emacs-lisp/shortdoc.el (string): Add examples. * lisp/emacs-lisp/subr-x.el (string-clean-whitespace) (string-fill, string-limit, string-lines, slice-string): New functions.
* shortdoc: prefer seq-contains-p over seq-containsBrian Leung2020-11-091-2/+2
| | | | | | | * lisp/emacs-lisp/shortdoc.el (sequence): use seq-contains-p instead of seq-contains, which is obsolete as of 27.1. (Bug#44536) Copyright-paperwork-exempt: yes
* ; Remove spurious FIXMEs in my last commitStefan Kangas2020-10-301-2/+0
|
* Add shortdoc navigation commandsStefan Kangas2020-10-301-3/+53
| | | | | | | | | | | | * lisp/emacs-lisp/shortdoc.el (text-property-search): Require. (shortdoc-mode): New major mode. (shortdoc-mode-map): New variable. (shortdoc--goto-section): New macro. (shortdoc-next, shortdoc-previous, shortdoc-next-section) (shortdoc-previous-section): New commands. (shortdoc-display-group): Use new shortdoc-models. Propertize section header. (shortdoc--display-function): Propertize function header.
* ; * lisp/emacs-lisp/shortdoc.el (regexp): less contrived rx exampleMattias Engdegård2020-10-281-1/+1
|
* Run substitute-command-keys on shortdoc section headingsStefan Kangas2020-10-281-1/+1
| | | | | * lisp/emacs-lisp/shortdoc.el (shortdoc-display-group): Run substitute-command-keys on section headings before displaying.
* Extend the regexp shortdoc groupStefan Kangas2020-10-281-10/+34
| | | | | * lisp/emacs-lisp/shortdoc.el (regexp): New section "Match Data"; add save-match-data. New section "The `rx' Structured Regexp Notation".
* Tweak how shortdocs are displayedLars Ingebrigtsen2020-10-261-16/+18
| | | | | | | | | * lisp/emacs-lisp/shortdoc.el (shortdoc-example): Removed. (shortdoc-section): Remove colors. (shortdoc-separator): New face. (shortdoc-display-group, shortdoc--display-function): Don't use background colours, because that makes things harder to read. Separate with a horizontal line instead.
* Add section "Replacing Match" to the regexp shortdoc groupStefan Kangas2020-10-251-0/+7
| | | | * lisp/emacs-lisp/shortdoc.el (regexp): New section "Replacing Match".
* Add shortdoc group for alistStefan Kangas2020-10-251-0/+39
| | | | * lisp/emacs-lisp/shortdoc.el (alist): New shortdoc group.
* Add shortdoc group for hash-tableStefan Kangas2020-10-251-0/+31
| | | | * lisp/emacs-lisp/shortdoc.el (hash-table): New shortdoc group.
* Simplify syntax of shortdoc face specsBasil L. Contovounesios2020-10-201-7/+4
| | | | | | * lisp/emacs-lisp/shortdoc.el: Remove unused dependency. (shortdoc-section, shortdoc-example): Use newer (DISPLAY . PLIST) face spec syntax.
* Fix error in file shortdoc groupLars Ingebrigtsen2020-10-111-0/+1
| | | | | * lisp/emacs-lisp/shortdoc.el (number): Add some more numeric stuff (and clean up some arglists).
* Improve documentation of shortdoc featuresEli Zaretskii2020-10-111-6/+7
| | | | | | | | | | * lisp/help-fns.el (help-fns-describe-function-functions): Doc fix. * lisp/emacs-lisp/shortdoc.el (define-short-documentation-group) (shortdoc-display-group, shortdoc-add-function): Doc fixes. * doc/lispref/help.texi (Documentation Groups): Improve the recently-added documentation and the indexing.
* Add more numeric shortdocsLars Ingebrigtsen2020-10-111-3/+23
| | | | | * lisp/emacs-lisp/shortdoc.el (shortdoc-section) (shortdoc-example): Lighten up colours on light backgrounds.
* Tweak shortdoc colours on light backgroundsLars Ingebrigtsen2020-10-111-2/+2
| | | | | * lisp/emacs-lisp/shortdoc.el (shortdoc-section) (shortdoc-example): Lighten up colours on light backgrounds.
* Autoload shortdoc command and adjust NEWSLars Ingebrigtsen2020-10-111-0/+1
| | | | * lisp/emacs-lisp/shortdoc.el (shortdoc-display-group): Autoload.
* Use Unicode arrows in shortdoc resultsLars Ingebrigtsen2020-10-111-7/+13
| | | | | * lisp/emacs-lisp/shortdoc.el (shortdoc--display-function): Use Unicode arrows if possible.
* Add support for displaying short documentation for function groupsLars Ingebrigtsen2020-10-111-0/+1077
* doc/lispref/help.texi (Documentation Groups): Document it. * lisp/help-fns.el (help-fns--mention-shortdoc-groups): Output references to the shortdocs. * lisp/emacs-lisp/shortdoc.el: New file.