Re: Description for ruby-mini-magick
(First draft after getting in from a LUG meeting; I may have second
thoughts in the morning.)
tornow@riseup.net wrote:
> please help me with the description for the package ruby-mini-magick.
>
> Description: manipulation of images with minimal use of memory via
> ImageMagick MiniMagick is a Ruby library providing a wrapper around
^
I assume the dividing line between synopsis and long description is
meant to be at the mark!
"Manipulation of images with minimal use of memory via ImageMagick" is
1) a bit long (for instance "with minimal use of memory", repeated in
the long description, could be just "lightweight" here);
2) pedantically speaking it's less a description of this software, and
more a description of what this software is for;
3) potentially ambiguous (maybe this is a stretch): if it's making
minimal use of memory via ImageMagick, it might be achieving
this by using a huge amount of memory via something else. You
could avoid this wilful misinterpretation by instead saying
"manipulation of images via ImageMagick with minimal use of
memory", or (better) by rephrasing it more thoroughly.
It shouldn't be hard to avoid all those problems, but at the moment I
can't decide between the various approaches:
Description: ImageMagick graphics processing routines using minimal memory
Description: lightweight API for ImageMagick image manipulation
Description: wrapper for ImageMagick with a small memory footprint
> [...] MiniMagick is a Ruby library providing a wrapper around
> ImageMagick or GraphicsMagick, allowing manipulation of images with
> minimal use of memory. MiniMagick gives access to all commandline
> options provided by ImageMagick (found here:
> http://www.imagemagick.org/script/mogrify.php).
>
> Is it ok in general? Is it better to leave the URL for mogrify or
> remove it?
It might benefit from an extra "the" between "all" and "commandline
options", but on the whole it's good. I would vote for dropping the
bit in parentheses - after all, it's the job of the imagemagick
package to provide pointers to that documentation, and it doesn't need
to be the upstream copy - users can access mogrify(1) without needing
to be online.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
Reply to: