RepoMirrors
/
mpv
mirror of https://github.com/mpv-player/mpv
1
0
Fork 0
Code Issues Releases Wiki Activity

DOCS/compatibility.rst: add requirement when changing default values 

Documented default values are relied upon by scripts, so changing these
values can casuse incompatible changes. This makes documenting them
required.
This commit is contained in:
nanahi 2024-05-16 02:17:57 -04:00 committed by Kacper Michajłow
parent eb38c3cb87
commit 46dbaff961
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
DOCS/compatibility.rst
View File

@ -29,6 +29,13 @@ All of these are important for interfacing both with end users and API users
(which include Lua scripts, libmpv, and the JSON IPC). As such, they constitute (which include Lua scripts, libmpv, and the JSON IPC). As such, they constitute
a large part of the user interface and APIs. a large part of the user interface and APIs.
Certain options and commands may have documented default values. These default
values are considered a part of the API since scripts may already rely on these
documented behaviors. Changing these defaults are considered incompatible
changes and must be documented. Undocumented default values do not subject to
this requirement, and it is recommended to discourage such usage in the related
documentations if there is a need to frequently change such defaults.
All incompatible changes to this must be declared in interface-changes.rst, All incompatible changes to this must be declared in interface-changes.rst,
which include the types of changes, the impact of these changes, and suggested which include the types of changes, the impact of these changes, and suggested
actions to address such impact so that the incompatibility is alleviated. actions to address such impact so that the incompatibility is alleviated.