Re: Status of vcard packages

[Arash Esbati <arash@gnu.org>]

Stefan Monnier via Users list for the GNU Emacs text editor <help-gnu-emacs@gnu.org> writes:

> Beside resolving the naming conflict, the code would benefit from some
> love, as well.

Here is a small change fixing some minor docstring issues.

--8<---------------cut here---------------start------------->8---
--- vcard.el~   2022-07-12 06:16:41.000000000 +0200
+++ vcard.el    2022-07-12 13:47:50.213543600 +0200
@@ -328,8 +328,8 @@
 of each attribute is the actual property list; the remaining elements are
 the values.

-If a specific property has an associated parameter \(e.g. an encoding\),
-use the syntax \(\"property\" . \"parameter\"\) to specify it.  If property
+If a specific property has an associated parameter (e.g. an encoding),
+use the syntax (\"property\" . \"parameter\") to specify it.  If property
 parameter is not important or it has no specific parameter, just specify
 the property name as a string."
   (let ((attrs vcard)
@@ -344,7 +344,7 @@
     (nreverse result)))

 (defun vcard-proplist-all-properties (proplist props)
-  "Returns nil unless PROPLIST contains all properties specified in PROPS."
+  "Return nil unless PROPLIST contains all properties specified in PROPS."
   (let ((result t))
     (while (and result props)
       (or (vcard-get-property proplist (car props))
@@ -353,7 +353,7 @@
     result))

 (defun vcard-proplist-any-properties (proplist props)
-  "Returns `t' if PROPLIST contains any of the properties specified in PROPS."
+  "Return t if PROPLIST contains any of the properties specified in PROPS."
   (let ((result nil))
     (while (and (not result) props)
       (and (vcard-get-property proplist (car props))
--8<---------------cut here---------------end--------------->8---

The byte-compiler from current master (cfda663282) also complains about:

vcard-parse.el:98:2: Warning: defvar `vcard-parse-select-fields' docstring has
    wrong usage of unescaped single quotes (use \= or different quoting)
vcard-parse.el:355:45: Warning: docstring has wrong usage of unescaped single
    quotes (use \= or different quoting)

I couldn't figure out why.

Best, Arash