[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#902267: ITP: jiq -- jid on jq



On Sun, Jun 24, 2018 at 07:46:06PM +0000, Zenon Mousmoulas wrote:

> I posted an updated ITP (should it be a new submission?) but let me try again, also correcting the license (s/MIT/Expat/). As for digger, I am afraid that is part of the acronym chosen by (the forked) upstream.
> 
> 
> Package: wnpp
> Severity: wishlist
> Owner: Zenon Mousmoulas <zmousm@noc.grnet.gr>
> 
> * Package name    : jiq
>   Version         : 0.6.0+git20180621.a79e8b2-1
>   Upstream Author : Giovanni T. Parra
> * URL             : https://github.com/fiatjaf/jiq
> * License         : Expat
>   Programming Lang: Go
>   Description     : json incremental digger (jid) with jq

Even though the name jid stands for json incremental digger, you don't
need to include that in the description. I'd certainly not use it in the
short description, but mention it in the long description so one can
still search for "incremental digger" and find this package. Also, the
acronym JSON should be spelled with all caps.

>  jiq is a fork of jid (https://github.com/simeji/jid) using
>  jq (https://stedolan.github.io/jq/) under the hood.

I would not mention these facts as the first thing in the description.

>  It is a command line tool that can be used to interactively drill
>  down on json input using jq filtering queries.

That's useful information. I'd still try to reword "drill down".

>  jiq calls jq and requires that it can be found in PATH.

This is useless information. Your package should have a Depends: jq, so
this will be taken care of automatically when you install your package.
Just like you won't see "foo uses the GNU standard C library and
requires that it be found in the standard system library paths or in
LD_LIBRARY_PATH".

Ok, it's easy to criticize, so let me try to make a description myself,
and then you can decide if you want to pick some things from it:

Description: interactive JSON query tool using jq expressions
 jiq is a command line tool that parses a JSON document and allows you
 to interactively query and filter it using jq expressions. jiq also
 provides suggestions and tab completion.
 .
 jiq is a fork of jid, but fully supports the jq language (see
 https://stedolan.github.io/jq/).

-- 
Met vriendelijke groet / with kind regards,
      Guus Sliepen <guus@debian.org>

Attachment: signature.asc
Description: PGP signature


Reply to: