Documented default values are relied upon by scripts, so changing these values can casuse incompatible changes. This makes documenting them required.
Unified · Split
| @@ -29,6 +29,13 @@ All of these are important for interfacing both with end users and API users · 28 unmodified lines | |||
| 29 | (which include Lua scripts, libmpv, and the JSON IPC). As such, they constitute | 29 | (which include Lua scripts, libmpv, and the JSON IPC). As such, they constitute |
| 30 | a large part of the user interface and APIs. | 30 | a large part of the user interface and APIs. |
| 31 | 31 | ||
| 32 | Certain options and commands may have documented default values. These default | ||
| 33 | values are considered a part of the API since scripts may already rely on these | ||
| 34 | documented behaviors. Changing these defaults are considered incompatible | ||
| 35 | changes and must be documented. Undocumented default values do not subject to | ||
| 36 | this requirement, and it is recommended to discourage such usage in the related | ||
| 37 | documentations if there is a need to frequently change such defaults. | ||
| 38 | |||
| 32 | All incompatible changes to this must be declared in interface-changes.rst, | 39 | All incompatible changes to this must be declared in interface-changes.rst, |
| 33 | which include the types of changes, the impact of these changes, and suggested | 40 | which include the types of changes, the impact of these changes, and suggested |
| 34 | actions to address such impact so that the incompatibility is alleviated. | 41 | actions to address such impact so that the incompatibility is alleviated. |