[Cod-bugs] comment suggestion for cod-tools, utility cif2xyz

Norwid Behrnd nbehrnd at yahoo.com
Wed Oct 26 20:10:54 EEST 2022


Dear maintainer of the cod-tools,

a recent problem report related to Jmol[1] lead me to check the .cif submitted
by Antanas Vaitkus in a conversion with the `cif2xyz` utility.  While this
worked fine /per sé/, I noticed running 

```shell
cif2xyz --help
```

provides a brief descriptor about what the program aims to provide -- however,
in contrast to e.g. calling --help for codcif2sdf, neither the name of the
utility, nor the early header (or footline) of the utility describes the
tool's provenance.  For a moment, I thought it would be of

https://jjppeters.github.io/CIF2XYZ/

instead.  As an improvement of the situation, I would hence suggest that
calling any of the (present) cod-tools with the --help flag briefly informs
the user about the source of the utility engaged, for example a line like

```
For further information, see https://wiki.crystallography.net/cod-tools/.
```

With best regards,

Norwid 

[1] https://github.com/BobHanson/Jmol-SwingJS/issues/32

---- 8>< ---- file(s) attached ---- ----
2022-10-26_cod-tools_comparison.png
---- 8>< ---- ----
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 2022-10-26_cod-tools_comparison.png
Type: image/png
Size: 80048 bytes
Desc: not available
URL: <http://lists.crystallography.net/pipermail/cod-bugs/attachments/20221026/e87e684b/attachment-0001.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 833 bytes
Desc: OpenPGP digital signature
URL: <http://lists.crystallography.net/pipermail/cod-bugs/attachments/20221026/e87e684b/attachment-0001.sig>


More information about the Cod-bugs mailing list