Re: Integrate my package into Emacs

[Stefan Monnier <monnier@iro.umontreal.ca>]

Mariano Montone [2022-05-24 16:22:37] wrote:
> I've signed the papers and applied your changes.

Yay!

> What would be the next step? Can you have a look again at my package let
> me know?

I just pushed it to `elpa.git`.  It won't appear on GNU ELPA yet, tho
because your copyright line still has your name.  You'll have to change
it to the FSF (and after that (or at the same time) change the
`Version:` to make a "new" release from that).

See patch below which includes the copyright change along with various
FIXME comments (meant to be read rather than applied.  If you have any
questions/answers about those FIXMEs, feel free to send them right here).


        Stefan


diff --git a/README.md b/README.md
index 06a6d142be..743dfcd604 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,11 @@ Inspector tool for Emacs Lisp objects.
 
 Similar to inspectors available for Smalltalk and Common Lisp, but for Emacs Lisp.
 
+<!-- FIXME: As far as I can tell, this cannot be viewed without
+     running Google's proprietary code in one's browser.
+     Any chance you can upload it to a site more respectful of its
+     users (like some PeerTube instance, maybe), or place a link that
+     goes straight to the MP4?  -->
 DEMO VIDEO: https://drive.google.com/file/d/1808JlDM0q-aW4woZQBscatxp6omIR2j8/view
 
 ![emacs-inspector.png](emacs-inspector.png "Emacs Inspector")
diff --git a/inspector.el b/inspector.el
index f32416198d..d011bc6ce0 100644
--- a/inspector.el
+++ b/inspector.el
@@ -1,6 +1,6 @@
 ;;; inspector.el --- Tool for inspection of Emacs Lisp objects.  -*- lexical-binding: t -*-
 
-;; Copyright (C) 2021 Mariano Montone
+;; Copyright (C) 2021-2022 Free Software Foundation, Inc.
 
 ;; Author: Mariano Montone <marianomontone@gmail.com>
 ;; URL: https://github.com/mmontone/emacs-inspector
@@ -616,6 +616,8 @@ When PRESERVE-HISTORY is T, inspector history is not cleared."
 
 ;;;###autoload
 (defun inspect-last-sexp ()
+  ;; FIXME: According to the code, this doesn't inspect the "sexp before point"
+  ;; but the value returned by the evaluation of that sexp.
   "Evaluate and inspect sexp before point."
   (interactive)
   (let ((result (eval (eval-sexp-add-defvars (elisp--preceding-sexp)) lexical-binding)))
@@ -623,6 +625,9 @@ When PRESERVE-HISTORY is T, inspector history is not cleared."
 
 ;;-- Inspection from Emacs debugger
 
+;; FIXME: Please use the "inspect-" namespace instead of stepping onto
+;; the debugger's namespace, e.g. `inspect-debugger-locals'.
+
 ;;;###autoload
 (defun debugger-inspect-locals ()
   "Inspect local variables of the frame at point in debugger backtrace."
@@ -683,13 +688,9 @@ When PRESERVE-HISTORY is T, inspector history is not cleared."
      :vert-only t)
     map))
 
-(add-hook 'inspector-mode-hook
-          (lambda ()
-            (setq-local tool-bar-map inspector-tool-bar-map)))
-
-;; Better define and use a major mode?:
-(define-derived-mode inspector-mode fundamental-mode
-  "Inspector mode")
+(define-derived-mode inspector-mode fundamental-mode "Inspector"
+  "Major mode for the Emacs Lisp Inspector."
+  (setq-local tool-bar-map inspector-tool-bar-map))
 
 (provide 'inspector)