[FFmpeg-devel] [PATCH v2] doc/filters: drawtext: add example of printing texts on same baseline

Lou Logan lou at lrcd.com
Wed Dec 14 20:48:00 EET 2016


On Wed, 14 Dec 2016 14:37:47 +0000, Andrey Utkin wrote:

>  * Added mention of @var{max_glyph_a} to "Note that..." phrase
>    (is the markup used for this correct?)

It's basically author's preference since the usage in the docs is
mixed and inconsistent, and we don't have any specific guidelines or
rules regarding usage of Texinfo "commands". However, this list may be
helpful:

<https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Indicating.html#Indicating>

What mostly matters is that commands, options, values, etc are
presented in a way that differentiates them from descriptive text, and
that usage is consistent. So for consistency I changed it to @option,
and it seems more like an option to me than a "metasyntactic variable".

(If someone wants to volunteer to clean up the Texinfo commands in the
docs that would certainly be welcome, but I think it would be a boring
and tedious task.)

>  doc/filters.texi | 8 ++++++++
>  1 file changed, 8 insertions(+)

Applied. Thanks.


More information about the ffmpeg-devel mailing list