GNU bug report logs - #51432
[PATCH 0/4] gnu: Add flask-combo-jsonapi

Previous Next

Full log

Message #23 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Tobias Geerinckx-Rice <me <at> tobias.gr>
To: david larsson <david.larsson <at> selfhosted.xyz>
Cc: Guix-patches <guix-patches-bounces+david.larsson=selfhosted.xyz <at> gnu.org>,
 guix-patches <at> gnu.org, 51432 <at> debbugs.gnu.org
Subject: Re: [bug#51432] [PATCH 3/4] gnu: Add marshmallow-jsonapi
Date: Wed, 03 Nov 2021 14:34:19 +0100

[Message part 1 (text/plain, inline)]

David,

> +        (base32
> +         "1d9pxcgmln4gls99vwj1h24qv0lz7fb2jqmqrsiv1pid1snc125x"))))
[…]
> +    (home-page
> +     "https://github.com/marshmallow-code/marshmallow-jsonapi")
> +    (synopsis
> +     "JSON API 1.0 (https://jsonapi.org) formatting with 
> marshmallow")

Nitpick: none of these need to be on separate lines (after 
removing the URL from the description).

Guix synopses and descriptions support (a comfortable subset of) 
Texinfo.  You can include hyperlinks in Texinfo with

 @uref{https://your.url/here, optional description}

For subjective reasons I decided to keep only the URL in the 
description.

> +    (description
> +     "JSON API 1.0 (https://jsonapi.org) formatting with 
> marshmallow")

Descriptions should consist of full sentences.  A single line is 
way too short.  Upstream has a fine description that fits our 
standards, so I adapted it:

+    (description
+     "The marshmallow-jsonapi package provides a simple way to 
produce
+@uref{https://jsonapi.org, JSON:API}-compliant data in any Python 
Web framework.
+It includes optional utilities to integrate with Flask.")

> +    (license license:expat))) ; MIT license

No need for this comment.

Thanks!

T G-R

[signature.asc (application/pgp-signature, inline)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.