]> git.eshelyaron.com Git - emacs.git/commitdiff
lisp/*.el: Minor docstring fixes
authorJuanma Barranquero <lekktu@gmail.com>
Mon, 10 Jun 2019 21:47:01 +0000 (23:47 +0200)
committerJuanma Barranquero <lekktu@gmail.com>
Mon, 10 Jun 2019 21:47:01 +0000 (23:47 +0200)
* 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.

lisp/subr.el
lisp/svg.el

index 54bee8a809f3c99e242000775300f6995d44874b..5a08cebf5560732f4a8b71b2a84ad42a0afb1daf 100644 (file)
@@ -5223,15 +5223,15 @@ This is the simplest safe way to acquire and release a mutex."
 (defvar definition-prefixes (make-hash-table :test 'equal)
   "Hash table mapping prefixes to the files in which they're used.
 This can be used to automatically fetch not-yet-loaded definitions.
-More specifically, if there is a value of the form (FILES...) for a string PREFIX
-it means that the FILES define variables or functions with names that start
-with PREFIX.
+More specifically, if there is a value of the form (FILES...) for
+a string PREFIX it means that the FILES define variables or functions
+with names that start with PREFIX.
 
 Note that it does not imply that all definitions starting with PREFIX can
 be found in those files.  E.g. if prefix is \"gnus-article-\" there might
-still be definitions of the form \"gnus-article-toto-titi\" in other files, which would
-presumably appear in this table under another prefix such as \"gnus-\"
-or \"gnus-article-toto-\".")
+still be definitions of the form \"gnus-article-toto-titi\" in other files,
+which would presumably appear in this table under another prefix such as
+\"gnus-\" or \"gnus-article-toto-\".")
 
 (defun register-definition-prefixes (file prefixes)
   "Register that FILE uses PREFIXES."
index 3384f1dbc0239f2b4bdfe2bc09e1684d35536482..0399c424c85a318ae21defd95719b4d704c44315 100644 (file)
@@ -30,7 +30,7 @@
 (eval-when-compile (require 'subr-x))
 
 (defun svg-create (width height &rest args)
-  "Create a new, empty SVG image with dimensions WIDTHxHEIGHT.
+  "Create a new, empty SVG image with dimensions WIDTH x HEIGHT.
 ARGS can be used to provide `stroke' and `stroke-width' parameters to
 any further elements added."
   (dom-node 'svg
@@ -42,8 +42,8 @@ any further elements added."
 
 (defun svg-gradient (svg id type stops)
   "Add a gradient with ID to SVG.
-TYPE is `linear' or `radial'.  STOPS is a list of percentage/color
-pairs."
+TYPE is `linear' or `radial'.
+STOPS is a list of percentage/color pairs."
   (svg--def
    svg
    (apply
@@ -66,9 +66,9 @@ pairs."
   "Create a rectangle on SVG, starting at position X/Y, of WIDTH/HEIGHT.
 ARGS is a plist of modifiers.  Possible values are
 
-:stroke-width PIXELS.  The line width.
-:stroke-color COLOR.  The line color.
-:gradient ID.  The gradient ID to use."
+:stroke-width PIXELS   The line width.
+:stroke-color COLOR    The line color.
+:gradient ID           The gradient ID to use."
   (svg--append
    svg
    (dom-node 'rect