-
Notifications
You must be signed in to change notification settings - Fork 2.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOCS/man/input.rst: remove input commands subject to change heading #15276
Conversation
Most of the commands list here are several years old and we will probably never change them. And it is already stated in the description of individual commands if they are deprecated or subject to change. Furthermore, it is easy to add new commands at the end of this section by accident. I added load-config-file and load-input-conf here without realizing it's a separate section, and I assume this was also the case for begin-vo-dragging.
The section exists for a reason. Input commands are subject to further scrutiny when changing compared to options and properties, and any input commands not listed in "subject to change" section cannot be broken in ANY circumstances, regardless of prior notice. This is outlined in
The "subject to change" section on the other hand is meant for the commands which are still subject to change and can be broken. By removing this section, all commands now cannot be broken for any reason anymore.
I added that command and I was very intentional to add the command to the "subject to change" section, for possibility of further improvments or even removal. Instead of this blanket transition, the commands should be evaluated in a case-by-case basis, and only move the commands which are sure won't change again to the main section. |
I did not know this section in compatibility.rst existed and it probably explains how the Yet I'm not sure if we absolutely need that notice in input.rst, since apparently we have some sort of "core" set with stronger guarantees anyway. |
Individual command descriptions already say if they are deprecated ( |
So just move these commands to the section where they are considered stable, like when I already suggested above? I don't get why you want to remove this section when fixing it by moving them to the stable section would achieve the same thing and is more clear than the current state. The commands need to evaluated in a case-by-case basis, and not all commands in that section need to have explicit language in the descriptions, like my intention for |
That would just be moving everything without the notice except begin-vo-dragging above, it is a smaller change to just remove the heading. I think having the experimental notice in the individual command is harder to miss because if I search a command's documentation I just read wherever it is and don't notice whether it is under "Input Commands that are Possibly Subject to Change" or not, in fact I put |
Most of the commands list here are several years old and we will probably never change them. And it is already stated in the description of individual commands if they are deprecated or subject to change.
Furthermore, it is easy to add new commands at the end of this section by accident. I added load-config-file and load-input-conf here without realizing it's a separate section, and I assume this was also the case for begin-vo-dragging.