On 06.09.2014 13:45, Reimar Döffinger wrote:
On Sat, Sep 06, 2014 at 12:13:30PM +0200, Andreas Cadhalpun wrote:
-Effectively this allows to add padding with zeros from the left.
+Effectively this allows one to add padding with zeros from the left.

Huh? I don't think the second is more correct, and it sure sounds worse.
What is this trying to say anyway?

The 'allows to' phrase is detected as spelling mistake by lintian.
But I agree, that it doesn't sound much better with the 'one' added.

Does it mean to say "This will pad with zeros from the left"?
The words "+Effectively" and "allows" to me seem to be just useless
and confusing fillers and should go, most uses of such filler words
is misplaced in documentation.

I'm wondering whether it will only pad, or also truncate the output, if it is too long? (I think it won't.) Reading the whole paragraph again, I noticed that some articles are missing, as well.
Attached is a patch trying to improve the wording of this paragraph.

Best regards,
Andreas

>From be0713f01537927ff4f87ec7f6ecb114beed2fc6 Mon Sep 17 00:00:00 2001
From: Andreas Cadhalpun <andreas.cadhal...@googlemail.com>
Date: Sat, 6 Sep 2014 23:49:43 +0200
Subject: [PATCH] doc/filters.texi: improve the wording of the expr_int_format
 documentation

---
 doc/filters.texi | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/doc/filters.texi b/doc/filters.texi
index 627f112..bb486ea 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -4083,11 +4083,11 @@ value.
 @item expr_int_format, eif
 Evaluate the expression's value and output as formatted integer.
 
-First argument is expression to be evaluated, same as for @var{expr} function.
-Second argument specifies output format. Allowed values are 'x', 'X', 'd' and
-'u', they are treated exactly as in printf function.
-Third parameter is optional and sets the number of positions taken by output.
-Effectively this allows to add padding with zeros from the left.
+The first argument is the expression to be evaluated, just as for the @var{expr} function.
+The second argument specifies the output format. Allowed values are 'x', 'X', 'd' and
+'u'. They are treated exactly as in the printf function.
+The third parameter is optional and sets the number of positions taken by the output.
+It can be used to add padding with zeros from the left.
 
 @item gmtime
 The time at which the filter is running, expressed in UTC.
-- 
2.1.0

_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
http://ffmpeg.org/mailman/listinfo/ffmpeg-devel

Reply via email to