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

Bug#927679: Please use docbook entities strictly for re-usable parts

Package: release-notes
Severity: wishlist
X-Debbugs-CC: debian-i18n@lists.debian.org

On Sb, 20 apr 19, 21:11:09, Justin B Rye wrote:
> Andrei POPESCU wrote:
> >> +      disable it before the upgrade, to ensure login sessions work on
> >> +      &releasename;. (A possible route to re-enabling it is outlined on the
> > 
> > Any particular reason for using "&releasename;" instead of "buster"?
> > 
> > At least for me it's easier to read (and understand) the source text 
> > without so much markup.
> I'll just have been copying the prevailing markup features from
> neighbouring sections..
> Personally I would be happy to see &releasename; etc. eliminated in
> any section that won't be kept for the buster->bullseye edition (and
> the places that don't change should rarely mention releasenames).
> It's not quite as bad as &debian;, which almost never makes sense,
> since anybody recycling this document for (e.g.) Devuan would need to
> change almost everything else, too.

It appears to be best practice in programming to use variables just 
about everywhere.

In my opinion the same does not necessarily apply here because:

1. This is documentation

2. The source code itself is read by many, potentially non-programmers 
(i.e. translators).

Turning this into a wishlist bug against the Release Notes, hopefully to 
be considered for bullseye.
Kind regards,

Attachment: signature.asc
Description: PGP signature

Reply to: