Gentoo Archives: gentoo-dev

From: Ulrich Mueller <ulm@g.o>
To: Sam James <sam@g.o>
Cc: gentoo-dev@l.g.o, glep@g.o
Subject: Re: [gentoo-dev] [PATCH 1/1] glep-0068: Add notes element for package maintenance instructions
Date: Wed, 06 Oct 2021 05:35:20
Message-Id: utuhuemwg@gentoo.org
In Reply to: [gentoo-dev] [PATCH 1/1] glep-0068: Add notes element for package maintenance instructions by Sam James
1 >>>>> On Tue, 05 Oct 2021, Sam James wrote:
2
3 > +Notes element
4 > +~~~~~~~~~~~~~
5 > +
6 > +The ``<notes/>`` element describes important information on how to maintain
7 > +a package.
8 > +
9 > +The ``<notes/>`` element has an obligatory ``type=""`` attribute whose value is
10 > +can be either ``text`` or ``url``. If its value is ``text``, then the
11
12 Too many verbs ("is can be") in this sentence.
13
14 > +``<notes/>`` value is formed of multi-line text. If its value is ``url``, the
15 > +``<notes/>`` value should be a link to a page containing information on how
16 > +to correct maintain the package.
17
18 Since this is plain text, it presumably should have an optional "lang"
19 attribute for consistency with other elements.
20
21 Ulrich