Commit add2cac5 authored by Juanma Barranquero's avatar Juanma Barranquero

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.
parent fdd1b3e0
Pipeline #1986 failed with stage
in 5 seconds
......@@ -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."
......
......@@ -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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment