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

Bug#878033: developers-reference: typos, etc.



Package: developers-reference
Version: 3.4.18
Severity: wishlist
Tags: patch

--

The proposed patches fix typos and make other suggested changes.  I
made these by hand on a printout of the PDF version, so they reflect
things I saw in that copy.

I did not make changes related to back-quotes or the ` character
disappearing in the PDF output.  I think that will take work in the
xslt files, but that will have to wait for now.

One typographical change I suggest making is changing "..." to the
Unicode horizontal ellipsis character, U+2026, HTML entity "…".
The ellipsis spreads out the periods more than if three periods are
just typed together.  I don't know what the implications will be for
all the various output formats though so I did not introduce that
change.

Comma splices generally replace the comma with a semicolon (I think I
did that in all cases).

The phrase "top-level" should be "top level" when used as a noun, not
an adjective; likewise, "third-parties" should be "third parties" as a
noun.

Some acronyms were spelled out the first time they were used (DSA,
API, and ABI).

There were a couple instances of "e.g. a, b, c, etc." or "like a, b,
c, etc."; in such a case, generally "e.g."/"like" or "etc." should be
used, but not both.  I retained the "etc.".

I made "which" vs. "that" changes in several places.

I modified common.ent to reflect that there are 10 (not 11) supported
architectures, and changed the names of stable, oldstable, etc. in
ENTITY declarations.

Note that in Section 5.4 concerning the first time a package is
uploaded, I changed "should" to "must" concerning including the
original source file.  I believe this is correct, because otherwise
the original source file is not part of the package.

Other things I observed but did not change:

Section 5.13.2: low priority packages no longer wait 10 days to
migrate to testing; they wait 5 days now.  If this is a permanent
change, I would update this section.

Section 5.13.3: recommend removing the ending punctuation in the list
for all elements except the final "." on the last element.

Section 6.7.8.1: tar can read a ".tar.gz" file directly without using
zcat; consider rewriting this line to just use tar.

Thank you,


Paul Hardy

Attachment: developers-reference-3.4.18.patches
Description: Binary data


Reply to: