--- Begin Message ---
- To: Debian Bug Tracking System <submit@bugs.debian.org>
- Subject: lwt: package description fixes
- From: Justin B Rye <justin.byam.rye@gmail.com>
- Date: Wed, 27 May 2015 19:42:40 +0100
- Message-id: <20150527184239.GA31993@xibalba.demon.co.uk>
Source: lwt
Version: 2.4.3-4
Severity: wishlist
Tags: patch
The package descriptions for the lwt packages have some trivial
non-native-English-speakerisms.
> Description: cooperative light-weight thread library for OCaml (runtime)
(Normally I'd recommend saying "light-weight cooperative threading
library", but presumably "Light-Weight Threads" is the canonical
expansion of "Lwt", so I'll leave the synopsis lines alone.)
> Lwt is a library of cooperative threads implemented in monadic style.
^^ ^
There's a missing article before that last noun phrase. Also, a
library *of* cooperative threads would be one that *uses* cooperative
threading. You mean:
Lwt is a library for cooperative threads implemented in a monadic style.
> With respect to preemptive threads, cooperative threads are not using
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^
You don't mean "with respect to"; you just mean "in contrast to" or simply
"unlike". And "are not" is a grammar error - it should be:
Unlike preemptive threads, cooperative threads do not use
> a scheduler to distribute processor time between threads. Instead of
^^
> this [...]
^^^^
The "of this" is redundant; you can just say "Instead, ..."
> [...] each thread must tell the others that he wants to let them
^^
> work.
The main reason I'm picking on this package description rather than
all the other not-fantastically-good-English package descriptions out
there is that even when anthropomorphised to the point of having
things they want to talk to one another about, threads are not male.
each thread must tell the others that it wants to let them work.
But is this true anyway? Surely the first thread doesn't send a
message to all the others - it's just:
each thread must announce that it wants to let the others run.
Or I could probably say it more concisely if I used the word "yield",
but then I would end up changing a lot more than is really necessary.
> .
> This package contains runtime libraries for programs using core Lwt.
The package-specific final paragraphs are also fine (though I've added
a "Harvard comma" to one of them).
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
diff -ru lwt-2.4.3.pristine/debian/control lwt-2.4.3/debian/control
--- lwt-2.4.3.pristine/debian/control 2013-11-09 07:10:14.000000000 +0000
+++ lwt-2.4.3/debian/control 2015-05-27 19:40:52.729740745 +0100
@@ -40,11 +40,10 @@
liblwt-glib-ocaml-dev
Breaks: ocsigen (<< 1.2.1)
Description: cooperative light-weight thread library for OCaml
- Lwt is a library of cooperative threads implemented in monadic style.
- With respect to preemptive threads, cooperative threads are not using
- a scheduler to distribute processor time between threads. Instead of
- this, each thread must tell the others that he wants to let them
- work.
+ Lwt is a library for cooperative threads implemented in a monadic style.
+ Unlike preemptive threads, cooperative threads do not use a scheduler to
+ distribute processor time between threads. Instead, each thread must
+ announce that it wants to let the others run.
.
This package contains all the development stuff you need to use the
core Lwt OCaml library in your programs.
@@ -59,11 +58,10 @@
Replaces: liblwt-ocaml-dev (<< 2.3.0)
Breaks: liblwt-ocaml-dev (<< 2.3.0)
Description: cooperative light-weight thread library for OCaml (runtime)
- Lwt is a library of cooperative threads implemented in monadic style.
- With respect to preemptive threads, cooperative threads are not using
- a scheduler to distribute processor time between threads. Instead of
- this, each thread must tell the others that he wants to let them
- work.
+ Lwt is a library for cooperative threads implemented in a monadic style.
+ Unlike preemptive threads, cooperative threads do not use a scheduler to
+ distribute processor time between threads. Instead, each thread must
+ announce that it wants to let the others run.
.
This package contains runtime libraries for programs using core Lwt.
@@ -80,11 +78,10 @@
liblwt-ocaml-doc,
ocaml-findlib
Description: cooperative OpenSSL bindings for OCaml
- Lwt is a library of cooperative threads implemented in monadic style.
- With respect to preemptive threads, cooperative threads are not using
- a scheduler to distribute processor time between threads. Instead of
- this, each thread must tell the others that he wants to let them
- work.
+ Lwt is a library for cooperative threads implemented in a monadic style.
+ Unlike preemptive threads, cooperative threads do not use a scheduler to
+ distribute processor time between threads. Instead, each thread must
+ announce that it wants to let the others run.
.
This package contains all the development stuff you need to use Lwt
with cooperative OpenSSL in your programs.
@@ -99,11 +96,10 @@
Replaces: liblwt-ocaml-dev (<= 2.3.0)
Breaks: liblwt-ocaml-dev (<= 2.3.0)
Description: cooperative OpenSSL bindings for OCaml (runtime)
- Lwt is a library of cooperative threads implemented in monadic style.
- With respect to preemptive threads, cooperative threads are not using
- a scheduler to distribute processor time between threads. Instead of
- this, each thread must tell the others that he wants to let them
- work.
+ Lwt is a library for cooperative threads implemented in a monadic style.
+ Unlike preemptive threads, cooperative threads do not use a scheduler to
+ distribute processor time between threads. Instead, each thread must
+ announce that it wants to let the others run.
.
This package contains runtime libraries for programs using Lwt with
cooperative OpenSSL.
@@ -121,11 +117,10 @@
liblwt-ocaml-doc,
ocaml-findlib
Description: cooperative GLib bindings for OCaml
- Lwt is a library of cooperative threads implemented in monadic style.
- With respect to preemptive threads, cooperative threads are not using
- a scheduler to distribute processor time between threads. Instead of
- this, each thread must tell the others that he wants to let them
- work.
+ Lwt is a library for cooperative threads implemented in a monadic style.
+ Unlike preemptive threads, cooperative threads do not use a scheduler to
+ distribute processor time between threads. Instead, each thread must
+ announce that it wants to let the others run.
.
This package contains all the development stuff you need to use Lwt
with cooperative GLib in your programs.
@@ -140,11 +135,10 @@
Replaces: liblwt-ocaml-dev (<= 2.3.0)
Breaks: liblwt-ocaml-dev (<= 2.3.0)
Description: cooperative GLib bindings for OCaml (runtime)
- Lwt is a library of cooperative threads implemented in monadic style.
- With respect to preemptive threads, cooperative threads are not using
- a scheduler to distribute processor time between threads. Instead of
- this, each thread must tell the others that he wants to let them
- work.
+ Lwt is a library for cooperative threads implemented in a monadic style.
+ Unlike preemptive threads, cooperative threads do not use a scheduler to
+ distribute processor time between threads. Instead, each thread must
+ announce that it wants to let the others run.
.
This package contains runtime libraries for programs using Lwt with
cooperative GLib.
@@ -160,11 +154,10 @@
Replaces: liblwt-ocaml-dev (<= 2.3.0)
Breaks: liblwt-ocaml-dev (<= 2.3.0)
Description: cooperative light-weight thread library (documentation)
- Lwt is a library of cooperative threads implemented in monadic style.
- With respect to preemptive threads, cooperative threads are not using
- a scheduler to distribute processor time between threads. Instead of
- this, each thread must tell the others that he wants to let them
- work.
+ Lwt is a library for cooperative threads implemented in a monadic style.
+ Unlike preemptive threads, cooperative threads do not use a scheduler to
+ distribute processor time between threads. Instead, each thread must
+ announce that it wants to let the others run.
.
This package contains the complete API reference for Lwt, including
- OpenSSL, GLib bindings and examples.
+ OpenSSL, GLib bindings, and examples.
--- End Message ---