obsolete numpydoc-template-desc; use numpydoc-template-arg-desc.

update news

version

README update

NEWS

@@ -2,9 +2,16 @@ numpydoc.el NEWS -- history of user visible changes
 
 * Unreleased
 
+TBD
+
+* 0.4 (May 23, 2021)
+
 ** Changes
 
-TBD
+*** Renamed numpydoc-template-desc to numpydoc-template-arg-desc
+Marked the previous custom variable as obsolete. This change makes the
+variable name consistent with the closely related variable
+`numpydoc-template-type-desc`.
 
 * 0.3.0 (May 10, 2021)
 

README.md

@@ -113,7 +113,7 @@ See inside Emacs with <kbd>M-x customize-group RET numpydoc</kbd>
   Template text that will be used as the long description if
   <code>numpydoc-insertion-style</code> is <code>nil</code>.
   </dd>
-  <dt>numpydoc-template-desc</dt>
+  <dt>numpydoc-template-arg-desc</dt>
   <dd>
   Template text that will be used for each function argument
   description if <code>numpydoc-insertion-style</code> is

numpydoc.el

@@ -6,7 +6,7 @@
 ;; Maintainer: Doug Davis <[email protected]>
 ;; URL: https://github.com/douglasdavis/numpydoc.el
 ;; SPDX-License-Identifier: GPL-3.0-or-later
-;; Version: 0.3.0
+;; Version: 0.4
 ;; Package-Requires: ((emacs "25.1") (s "1.12.0") (dash "2.18.0"))
 ;; Keywords: convenience
 
@@ -106,7 +106,11 @@ body has raise statements."
   :group 'numpydoc
   :type 'string)
 
-(defcustom numpydoc-template-desc "FIXME: Add docs."
+(define-obsolete-variable-alias
+  'numpydoc-template-desc 'numpydoc-template-arg-desc
+  "numpydoc 0.4")
+
+(defcustom numpydoc-template-arg-desc "FIXME: Add docs."
   "Template text for individual component descriptions.
 This will be added for individual argument and return description
 text, and below the Examples section."
@@ -385,7 +389,7 @@ This function assumes the cursor to be in the function body."
 (defun numpydoc--insert-item-desc (indent element)
   "Insert ELEMENT parameter description at level INDENT."
   (let* ((tmpd (cond ((numpydoc--yas-p) numpydoc--yas-replace-pat)
-                     (t numpydoc-template-desc)))
+                     (t numpydoc-template-arg-desc)))
          (desc (concat (make-string 4 ?\s)
                       (if (numpydoc--prompt-p)
                           (read-string (format "Description for %s: "
@@ -412,7 +416,7 @@ This function assumes the cursor to be in the function body."
 (defun numpydoc--insert-return (indent fnret)
   "Insert FNRET (return) description (if exists) at INDENT level."
   (let ((tmpr (cond ((numpydoc--yas-p) numpydoc--yas-replace-pat)
-                    (t numpydoc-template-desc))))
+                    (t numpydoc-template-arg-desc))))
     (when (and fnret (not (string= fnret "None")))
       (insert "\n")
       (numpydoc--insert indent
@@ -442,7 +446,7 @@ This function assumes the cursor to be in the function body."
 (defun numpydoc--insert-examples (indent)
   "Insert function examples block at INDENT level."
   (let ((tmpd (cond ((numpydoc--yas-p) numpydoc--yas-replace-pat)
-                    (t numpydoc-template-desc))))
+                    (t numpydoc-template-arg-desc))))
     (when numpydoc-insert-examples-block
       (insert "\n")
       (numpydoc--insert indent