[FFmpeg-devel] [PATCH] doc/developer: origin of tables should be documented.

Valentin Schweitzer valentin.schweitzer98 at gmail.com
Mon Aug 3 17:45:05 EEST 2020


> Can other developers give their input on this?

I am not currently a FFmpeg developer, so my opinion might
be less relevant than what others have stated.

I think giving a source for things that are not inherently
obvious, but are part of the code is a good idea. Even if
some tables are well explained in some standards or some
values are in their very nature a "magic number", knowing
which standard the table was taken from, or knowing if a
certain value *is* a magic number gives other devs the
information to research and answer their questions
themselves, with little work for the original author.
Some more documentation, be it about source code or
usage may also decrease the rate of questions on
the mailing lists.

Forcing people to source everything leads to useless
sources, but if it's not clear whether or not a piece
of code needs further explanation, I think verbosity
is the better idea.




More information about the ffmpeg-devel mailing list