mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-21 18:23:59 +00:00
Code Issues Releases Activity

lisp/*.el: Minor docstring fixes

Browse Source 
* 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.
This commit is contained in:
Juanma Barranquero 2019-06-10 23:47:01 +02:00
parent fdd1b3e020
commit add2cac586
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lisp/subr.el
View 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) (defvar definition-prefixes (make-hash-table :test 'equal)
"Hash table mapping prefixes to the files in which they're used. "Hash table mapping prefixes to the files in which they're used.
This can be used to automatically fetch not-yet-loaded definitions. 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 More specifically, if there is a value of the form (FILES...) for
it means that the FILES define variables or functions with names that start a string PREFIX it means that the FILES define variables or functions
with PREFIX. with names that start with PREFIX.
Note that it does not imply that all definitions starting with PREFIX can 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 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 still be definitions of the form \"gnus-article-toto-titi\" in other files,
presumably appear in this table under another prefix such as \"gnus-\" which would presumably appear in this table under another prefix such as
or \"gnus-article-toto-\".") \"gnus-\" or \"gnus-article-toto-\".")
(defun register-definition-prefixes (file prefixes) (defun register-definition-prefixes (file prefixes)
"Register that FILE uses PREFIXES." "Register that FILE uses PREFIXES."

12
lisp/svg.el
View File

@ -30,7 +30,7 @@
(eval-when-compile (require 'subr-x)) (eval-when-compile (require 'subr-x))
(defun svg-create (width height &rest args) (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 ARGS can be used to provide `stroke' and `stroke-width' parameters to
any further elements added." any further elements added."
(dom-node 'svg (dom-node 'svg
@ -42,8 +42,8 @@ any further elements added."
(defun svg-gradient (svg id type stops) (defun svg-gradient (svg id type stops)
"Add a gradient with ID to SVG. "Add a gradient with ID to SVG.
TYPE is `linear' or `radial'. STOPS is a list of percentage/color TYPE is `linear' or `radial'.
pairs." STOPS is a list of percentage/color pairs."
(svg--def (svg--def
svg svg
(apply (apply
@ -66,9 +66,9 @@ pairs."
"Create a rectangle on SVG, starting at position X/Y, of WIDTH/HEIGHT. "Create a rectangle on SVG, starting at position X/Y, of WIDTH/HEIGHT.
ARGS is a plist of modifiers. Possible values are ARGS is a plist of modifiers. Possible values are
:stroke-width PIXELS. The line width. :stroke-width PIXELS The line width.
:stroke-color COLOR. The line color. :stroke-color COLOR The line color.
:gradient ID. The gradient ID to use." :gradient ID The gradient ID to use."
(svg--append (svg--append
svg svg
(dom-node 'rect (dom-node 'rect