[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] master 8130186: Add docstrings to cl-print entry points
From: |
Mark Oteiza |
Subject: |
[Emacs-diffs] master 8130186: Add docstrings to cl-print entry points |
Date: |
Mon, 11 Sep 2017 22:16:59 -0400 (EDT) |
branch: master
commit 8130186cfb830d82e7d0cc6fb7443e3b6e026660
Author: Mark Oteiza <address@hidden>
Commit: Mark Oteiza <address@hidden>
Add docstrings to cl-print entry points
* lisp/emacs-lisp/cl-print.el (cl-print-compiled): Fix docstring.
(cl-prin1, cl-prin1-to-string): Add docstrings.
---
lisp/emacs-lisp/cl-print.el | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/lisp/emacs-lisp/cl-print.el b/lisp/emacs-lisp/cl-print.el
index 6a292d2..fec5e86 100644
--- a/lisp/emacs-lisp/cl-print.el
+++ b/lisp/emacs-lisp/cl-print.el
@@ -85,7 +85,8 @@ call other entry points instead, such as `cl-prin1'."
'help-echo (purecopy "mouse-2, RET: disassemble this function"))
(defvar cl-print-compiled nil
- "Control how to print byte-compiled functions. Can be:
+ "Control how to print byte-compiled functions.
+Acceptable values include:
- `static' to print the vector of constants.
- `disassemble' to print the disassembly of the code.
- nil to skip printing any details about the code.")
@@ -253,6 +254,11 @@ into a button whose action shows the function's
disassembly.")
;;;###autoload
(defun cl-prin1 (object &optional stream)
+ "Print OBJECT on STREAM according to its type.
+Output is further controlled by the variables
+`cl-print-readably', `cl-print-compiled', along with output
+variables for the standard printing functions. See Info
+node `(elisp)Output Variables'. "
(cond
(cl-print-readably (prin1 object stream))
((not print-circle) (cl-print-object object stream))
@@ -262,6 +268,7 @@ into a button whose action shows the function's
disassembly.")
;;;###autoload
(defun cl-prin1-to-string (object)
+ "Return a string containing the `cl-prin1'-printed representation of OBJECT."
(with-temp-buffer
(cl-prin1 object (current-buffer))
(buffer-string)))
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] master 8130186: Add docstrings to cl-print entry points,
Mark Oteiza <=