Status of vcard packages

Status of vcard packages

[Pascal Quesseveur]

Hello,

I don't quite understand the situation regarding vcard manipulation
libraries.

mm-view in Gnus uses the vcard printing functions defined in N.
Friedmann's vcard.el, when these functions are available. The file
contains functions that format VCard data but is limited to Vcard
version 2.1. At one time, this file was in the Gnus contrib directory.

There is also a package called vcard in GNU ELPA (by E.q
Abrahamsen). The functions in vcard-parse deal with different versions
of VCard but they are not used in Gnus. If the 2 files cannot be
merged, wouldn't it be better to rename one of the 2 libraries and put
them both in the form of ELPA packages, knowing that vcard.el is
referenced by Gnus?


-- 
Pascal Quesseveur
pquessev@gmail.com

Re: Status of vcard packages

[Stefan Monnier via Users list for the GNU Emacs text editor]

Pascal Quesseveur [2022-07-11 16:23:31] wrote:
> There is also a package called vcard in GNU ELPA (by E.q
> Abrahamsen). The functions in vcard-parse deal with different versions
> of VCard but they are not used in Gnus. If the 2 files cannot be
> merged, wouldn't it be better to rename one of the 2 libraries and put
> them both in the form of ELPA packages, knowing that vcard.el is
> referenced by Gnus?

Indeed, the situation looks like a mess.  Luckily there should be no big
difficulty adding the vcard.el code by Noah Friedmann to the `vcard`
package in GNU ELPA (so as to resolve the naming conflict).

Beside resolving the naming conflict, the code would benefit from some
love, as well.  You seem to be a good candidate to try and tackle this.


        Stefan

Re: Status of vcard packages

[Pascal Quesseveur]

  Ok.


-- 
Pascal Quesseveur
pquessev@gmail.com

Re: Status of vcard packages

[Arash Esbati]

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

Re: Status of vcard packages

[Robert Pluim]

>>>>> On Tue, 12 Jul 2022 14:14:26 +0200, Arash Esbati <arash@gnu.org> said:

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

Single quotes in docstrings can end up displayed incorrectly. Either
do:

`foo'

or if you really must have a single quote:

\\='foo

Robert
-- 

Re: Status of vcard packages

[Stefan Monnier]

Arash Esbati [2022-07-12 14:14:26] wrote:
>  (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---

Thanks.

> 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)

This is fixed in the version I installed yesterday into the GNU ELPA
version of `vcard`.  It's not yet released but you can see the preview
at

    http://elpa.gnu.org/devel/vcard.html


-- Stefan

Re: Status of vcard packages

[Arash Esbati]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

> This is fixed in the version I installed yesterday into the GNU ELPA
> version of `vcard`.

Sorry, my bad.  I was looking at the code from the git repo and the
warnings from the ELPA release.

Best, Arash

Re: Status of vcard packages

[Arash Esbati]

Robert Pluim <rpluim@gmail.com> writes:

> Single quotes in docstrings can end up displayed incorrectly.

Thanks.  I was confused as the docstrings were already fixed by Stefan
and I was looking for the source of trouble in the updated code.

Best, arash