[FFmpeg-devel] [PATCH] doc/filters/aspect: update documentation

[FFmpeg-devel] [PATCH] doc/filters/aspect: update documentation

[Stefano Sabatini]

Drop mention of unsupported N:M syntax, dropped since 0ed61546c459.

Also, drop reference of common expression constants, and fix
description of a expression parameter.

Fix issue:
http://trac.ffmpeg.org/ticket/9974
---
 doc/filters.texi | 18 +++++-------------
 1 file changed, 5 insertions(+), 13 deletions(-)

diff --git a/doc/filters.texi b/doc/filters.texi
index 889de8b11a..8d4c6ae2f6 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -20888,12 +20888,9 @@ It accepts the following parameters:
 @item r, ratio, dar (@code{setdar} only), sar (@code{setsar} only)
 Set the aspect ratio used by the filter.
 
-The parameter can be a floating point number string, an expression, or
-a string of the form @var{num}:@var{den}, where @var{num} and
-@var{den} are the numerator and denominator of the aspect ratio. If
-the parameter is not specified, it is assumed the value "0".
-In case the form "@var{num}:@var{den}" is used, the @code{:} character
-should be escaped.
+The parameter can be a floating point number string, or an expression. If the
+parameter is not specified, it is assumed the value "0", meaning that the same
+input value is assumed.
 
 @item max
 Set the maximum integer value to use for expressing numerator and
@@ -20902,19 +20899,14 @@ Default value is @code{100}.
 
 @end table
 
-The parameter @var{sar} is an expression containing
-the following constants:
+The parameter @var{sar} is an expression containing the following constants:
 
 @table @option
-@item E, PI, PHI
-These are approximated values for the mathematical constants e
-(Euler's number), pi (Greek pi), and phi (the golden ratio).
-
 @item w, h
 The input width and height.
 
 @item a
-These are the same as @var{w} / @var{h}.
+Same as @var{w} / @var{h}.
 
 @item sar
 The input sample aspect ratio.
-- 
2.25.1

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

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".

Re: [FFmpeg-devel] [PATCH] doc/filters/aspect: update documentation

[Gyan Doshi]

On 2023-03-26 11:45 pm, Stefano Sabatini wrote:
> Drop mention of unsupported N:M syntax, dropped since 0ed61546c459.
>
> Also, drop reference of common expression constants, and fix
> description of a expression parameter.
>
> Fix issue:
> http://trac.ffmpeg.org/ticket/9974
> ---
>   doc/filters.texi | 18 +++++-------------
>   1 file changed, 5 insertions(+), 13 deletions(-)
>
> diff --git a/doc/filters.texi b/doc/filters.texi
> index 889de8b11a..8d4c6ae2f6 100644
> --- a/doc/filters.texi
> +++ b/doc/filters.texi
> @@ -20888,12 +20888,9 @@ It accepts the following parameters:
>   @item r, ratio, dar (@code{setdar} only), sar (@code{setsar} only)
>   Set the aspect ratio used by the filter.
>   
> -The parameter can be a floating point number string, an expression, or
> -a string of the form @var{num}:@var{den}, where @var{num} and
> -@var{den} are the numerator and denominator of the aspect ratio. If
> -the parameter is not specified, it is assumed the value "0".
> -In case the form "@var{num}:@var{den}" is used, the @code{:} character
> -should be escaped.
> +The parameter can be a floating point number string, or an expression. If the
> +parameter is not specified, it is assumed the value "0", meaning that the same
> +input value is assumed.

A more idiomatic phrase would be

`If the parameter is not specified, the value "0" is assumed, meaning that the input value is used.`


Regards,
Gyan

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

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".

Re: [FFmpeg-devel] [PATCH] doc/filters/aspect: update documentation

[Stefano Sabatini]

On date Monday 2023-03-27 10:09:29 +0530, Gyan Doshi wrote:
> 
> 
> On 2023-03-26 11:45 pm, Stefano Sabatini wrote:
> > Drop mention of unsupported N:M syntax, dropped since 0ed61546c459.
> > 
> > Also, drop reference of common expression constants, and fix
> > description of a expression parameter.
> > 
> > Fix issue:
> > http://trac.ffmpeg.org/ticket/9974
> > ---
> >   doc/filters.texi | 18 +++++-------------
> >   1 file changed, 5 insertions(+), 13 deletions(-)
> > 
> > diff --git a/doc/filters.texi b/doc/filters.texi
> > index 889de8b11a..8d4c6ae2f6 100644
> > --- a/doc/filters.texi
> > +++ b/doc/filters.texi
> > @@ -20888,12 +20888,9 @@ It accepts the following parameters:
> >   @item r, ratio, dar (@code{setdar} only), sar (@code{setsar} only)
> >   Set the aspect ratio used by the filter.
> > -The parameter can be a floating point number string, an expression, or
> > -a string of the form @var{num}:@var{den}, where @var{num} and
> > -@var{den} are the numerator and denominator of the aspect ratio. If
> > -the parameter is not specified, it is assumed the value "0".
> > -In case the form "@var{num}:@var{den}" is used, the @code{:} character
> > -should be escaped.
> > +The parameter can be a floating point number string, or an expression. If the
> > +parameter is not specified, it is assumed the value "0", meaning that the same
> > +input value is assumed.
> 
> A more idiomatic phrase would be
> 
> `If the parameter is not specified, the value "0" is assumed, meaning that the input value is used.`

Fixed and applied, thanks.
_______________________________________________
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

To unsubscribe, visit link above, or email
ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".