Skip to content

Commit add2cac

Browse files
committed
lisp/*.el: Minor docstring fixes
* lisp/subr.el (definition-prefixes): Reflow docstring. * lisp/svg.el (svg-create): Doc fix to allow arg higlighting. (svg-gradient, svg-rectangle): Improve docstring formatting.
1 parent fdd1b3e commit add2cac

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

lisp/subr.el

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5223,15 +5223,15 @@ This is the simplest safe way to acquire and release a mutex."
52235223
(defvar definition-prefixes (make-hash-table :test 'equal)
52245224
"Hash table mapping prefixes to the files in which they're used.
52255225
This can be used to automatically fetch not-yet-loaded definitions.
5226-
More specifically, if there is a value of the form (FILES...) for a string PREFIX
5227-
it means that the FILES define variables or functions with names that start
5228-
with PREFIX.
5226+
More specifically, if there is a value of the form (FILES...) for
5227+
a string PREFIX it means that the FILES define variables or functions
5228+
with names that start with PREFIX.
52295229
52305230
Note that it does not imply that all definitions starting with PREFIX can
52315231
be found in those files. E.g. if prefix is \"gnus-article-\" there might
5232-
still be definitions of the form \"gnus-article-toto-titi\" in other files, which would
5233-
presumably appear in this table under another prefix such as \"gnus-\"
5234-
or \"gnus-article-toto-\".")
5232+
still be definitions of the form \"gnus-article-toto-titi\" in other files,
5233+
which would presumably appear in this table under another prefix such as
5234+
\"gnus-\" or \"gnus-article-toto-\".")
52355235

52365236
(defun register-definition-prefixes (file prefixes)
52375237
"Register that FILE uses PREFIXES."

lisp/svg.el

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
(eval-when-compile (require 'subr-x))
3131

3232
(defun svg-create (width height &rest args)
33-
"Create a new, empty SVG image with dimensions WIDTHxHEIGHT.
33+
"Create a new, empty SVG image with dimensions WIDTH x HEIGHT.
3434
ARGS can be used to provide `stroke' and `stroke-width' parameters to
3535
any further elements added."
3636
(dom-node 'svg
@@ -42,8 +42,8 @@ any further elements added."
4242

4343
(defun svg-gradient (svg id type stops)
4444
"Add a gradient with ID to SVG.
45-
TYPE is `linear' or `radial'. STOPS is a list of percentage/color
46-
pairs."
45+
TYPE is `linear' or `radial'.
46+
STOPS is a list of percentage/color pairs."
4747
(svg--def
4848
svg
4949
(apply
@@ -66,9 +66,9 @@ pairs."
6666
"Create a rectangle on SVG, starting at position X/Y, of WIDTH/HEIGHT.
6767
ARGS is a plist of modifiers. Possible values are
6868
69-
:stroke-width PIXELS. The line width.
70-
:stroke-color COLOR. The line color.
71-
:gradient ID. The gradient ID to use."
69+
:stroke-width PIXELS The line width.
70+
:stroke-color COLOR The line color.
71+
:gradient ID The gradient ID to use."
7272
(svg--append
7373
svg
7474
(dom-node 'rect

0 commit comments

Comments
 (0)