Subject: Re: [bug#53500] Add 42 rust packages, and update 4 of them

From: Nicolas Goaziou <[email-masked]>
Date: Mon, 24 Jan 2022 13:24:46 +0100

Hello,

Attila Lendvai <[email-masked]> writes:

> this is part of my struggle to package openethereum.
>
> this patch series is a rebase of https://issues.guix.gnu.org/53401 which has unfortunately developed countless merge conflicts.
>
> this one supersedes 53401, which i have closed for good.
>
> please apply at your earliest convenience, before this one also
> develops merge conflicts.

Thank you.

Could you fix some synopses and descriptions of added packages. In
particular, a synopsis cannot start with an article, and the description
is expected to consist of full sentences. At the very least, when
inspiration is not there, you can use "This package provides ..."
template.

> -    (synopsis "Rustc-serialize compatible hex conversion traits")
> -    (description "This package provides rustc-serialize compatible hex
> -conversion traits.")
> +    (synopsis "@code{rustc-serialize} compatible hex conversion traits")
> +    (description synopsis)

Here you removed a decent synopsis+description with something less good.

> +    (synopsis "General bytes-related utilities used in Parity Technologies projects")

I would remove the "used in" part, which is not useful.

> +    (description synopsis)

Hmmm, no :)

> +    (synopsis "Crate used in Parity Technologies projects")
> +    (description synopsis)

See above.

> +    (synopsis "Salsa20 Stream Cipher")
> +    (description synopsis)

Synopsis does not need to be titlecased.

Description should differ from synopsis.

> +    (synopsis "AST representation used by Serde derive macros")
> +    (description "AST representation used by Serde derive macros.  Unstable.")

Description should use full sentences.

> +    (synopsis "The bare essentials of std::io for use in no_std")

Don't start a synopsis with "The"

> +    (description
> +      "The bare essentials of std::io for use in no_std.  Alloc support is optional.")

The first sentence is not complete.

I won't comment each description, you get the picture.

Could you send an updated patch?

Regards,
-- 
Nicolas Goaziou