[FFmpeg-devel] [PATCH] Complete rewrite of the "fps" video filter section. More accurate.

[Jim DeLaHunt]

On 2020-04-27 01:04, Marton Balint wrote:

>
> On Sun, 26 Apr 2020, list+ffmpeg-dev at jdlh.com wrote:
>
>> From: Jim DeLaHunt <from+ffmpeg-dev at jdlh.com>
>>
>> This is a complete rewrite of the documentation for the "fps" video
>> filter. It describes the filter's behaviour more clearly and accurately.
>> I based the rewrite on reading the source code in vf_fps.c closely.
>
> IMHO it is way too verbose now.
>
> Regards,
> Marton
>
I agree, there are a lot more words. On the other hand it now describes 
what the filter actually does, without forcing a user to read the code. 
(And the code isn't straightforward, there is an event-driven style to 
video filter code which takes a bit of learning.)

However, I'm confident it could be improved.

It would be useful for reviewers to comment on:

 1. Is there information which should be kept, but expressed with fewer
    words?
 2. Is there information which is true description of the filter, but
    which the documentation should not bother to disclose?

I'm of the opinion that FFmpeg users are impeded a lot more by necessary 
facts left out of documentation than by too many words left in.
>>
>> No code, or other documentation files, are touched by this change.
>>
>> Signed-off-by: Jim DeLaHunt <from+ffmpeg-dev at jdlh.com>
Cheers,

       —Jim DeLaHunt, software engineer, Vancouver, Canada