aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuanma Barranquero2019-06-10 23:47:01 +0200
committerJuanma Barranquero2019-06-10 23:47:01 +0200
commitadd2cac586d29c574ae4ba12a2252dce0694f1d4 (patch)
treece243fe248d16ceb2a4a9eba17e0adee79a1ddaa
parentfdd1b3e02097966e7ffe8065f6e3d27f5f540d0a (diff)
downloademacs-add2cac586d29c574ae4ba12a2252dce0694f1d4.tar.gz
emacs-add2cac586d29c574ae4ba12a2252dce0694f1d4.zip
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.
-rw-r--r--lisp/subr.el12
-rw-r--r--lisp/svg.el12
2 files changed, 12 insertions, 12 deletions
diff --git a/lisp/subr.el b/lisp/subr.el
index 54bee8a809f..5a08cebf556 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -5223,15 +5223,15 @@ This is the simplest safe way to acquire and release a mutex."
5223(defvar definition-prefixes (make-hash-table :test 'equal) 5223(defvar definition-prefixes (make-hash-table :test 'equal)
5224 "Hash table mapping prefixes to the files in which they're used. 5224 "Hash table mapping prefixes to the files in which they're used.
5225This can be used to automatically fetch not-yet-loaded definitions. 5225This can be used to automatically fetch not-yet-loaded definitions.
5226More specifically, if there is a value of the form (FILES...) for a string PREFIX 5226More specifically, if there is a value of the form (FILES...) for
5227it means that the FILES define variables or functions with names that start 5227a string PREFIX it means that the FILES define variables or functions
5228with PREFIX. 5228with names that start with PREFIX.
5229 5229
5230Note that it does not imply that all definitions starting with PREFIX can 5230Note that it does not imply that all definitions starting with PREFIX can
5231be found in those files. E.g. if prefix is \"gnus-article-\" there might 5231be found in those files. E.g. if prefix is \"gnus-article-\" there might
5232still be definitions of the form \"gnus-article-toto-titi\" in other files, which would 5232still be definitions of the form \"gnus-article-toto-titi\" in other files,
5233presumably appear in this table under another prefix such as \"gnus-\" 5233which would presumably appear in this table under another prefix such as
5234or \"gnus-article-toto-\".") 5234\"gnus-\" or \"gnus-article-toto-\".")
5235 5235
5236(defun register-definition-prefixes (file prefixes) 5236(defun register-definition-prefixes (file prefixes)
5237 "Register that FILE uses PREFIXES." 5237 "Register that FILE uses PREFIXES."
diff --git a/lisp/svg.el b/lisp/svg.el
index 3384f1dbc02..0399c424c85 100644
--- a/lisp/svg.el
+++ b/lisp/svg.el
@@ -30,7 +30,7 @@
30(eval-when-compile (require 'subr-x)) 30(eval-when-compile (require 'subr-x))
31 31
32(defun svg-create (width height &rest args) 32(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.
34ARGS can be used to provide `stroke' and `stroke-width' parameters to 34ARGS can be used to provide `stroke' and `stroke-width' parameters to
35any further elements added." 35any further elements added."
36 (dom-node 'svg 36 (dom-node 'svg
@@ -42,8 +42,8 @@ any further elements added."
42 42
43(defun svg-gradient (svg id type stops) 43(defun svg-gradient (svg id type stops)
44 "Add a gradient with ID to SVG. 44 "Add a gradient with ID to SVG.
45TYPE is `linear' or `radial'. STOPS is a list of percentage/color 45TYPE is `linear' or `radial'.
46pairs." 46STOPS is a list of percentage/color pairs."
47 (svg--def 47 (svg--def
48 svg 48 svg
49 (apply 49 (apply
@@ -66,9 +66,9 @@ pairs."
66 "Create a rectangle on SVG, starting at position X/Y, of WIDTH/HEIGHT. 66 "Create a rectangle on SVG, starting at position X/Y, of WIDTH/HEIGHT.
67ARGS is a plist of modifiers. Possible values are 67ARGS is a plist of modifiers. Possible values are
68 68
69:stroke-width PIXELS. The line width. 69:stroke-width PIXELS The line width.
70:stroke-color COLOR. The line color. 70:stroke-color COLOR The line color.
71:gradient ID. The gradient ID to use." 71:gradient ID The gradient ID to use."
72 (svg--append 72 (svg--append
73 svg 73 svg
74 (dom-node 'rect 74 (dom-node 'rect