[elpa] externals/inspector 2f3c4db470 1/3: More detailed inspect-object docstring

[ELPA Syncer]

branch: externals/inspector
commit 2f3c4db470d8f830cc323408d8ddf73cb8bc3968
Author: Mariano Montone <marianomontone@gmail.com>
Commit: Mariano Montone <marianomontone@gmail.com>

    More detailed inspect-object docstring
---
 inspector.el | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/inspector.el b/inspector.el
index a604691cf3..074da24b8a 100644
--- a/inspector.el
+++ b/inspector.el
@@ -246,7 +246,13 @@ slice in buffer."
 ;;--------- Object inspectors ----------------------------------
 
 (cl-defgeneric inspect-object (object)
-  "Render inspector buffer for OBJECT.")
+  "Render inspector buffer for OBJECT.
+
+Methods of this generic function are expected to specialize on the type of 
Emacs Lisp OBJECT being inspected, and write into the current-buffer.
+The current-buffer is presumed to be empty.
+An inspector buffer is expected to have a title, some properties and a body.
+See `inspector--insert-title', `inspector--insert-label' and 
`inspector--insert-value' for inserting title, and properties and its values.
+For linking to another object, `inspector--insert-inspect-button' is expected 
to be used."
 
 (cl-defmethod inspect-object ((class (subclass eieio-default-superclass)))
   "Render inspector buffer for EIEIO CLASS."