-
-
Notifications
You must be signed in to change notification settings - Fork 97
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
Add introduction date of classes and methods in the documentation #11836
Comments
This was requested elsewhere already (on a per-property basis), but I can't find it right now. |
This can be very helpful when you swap between versions a lot, and especially if the same version of the documentation is often used as reference for multiple versions at once. This kind of feature is also available in the NumPy docs (example) (and, I'm sure, in many others too). |
This would be especially useful for tool developers. |
For historical context, there was a version attribute, but it marked the overall engine version, not the introduction of a specific feature: godotengine/godot#79092 |
Regarding how to introduce this to the class reference, how should we proceed? I assume this will take the form of an optional For existing members, we will probably have to label all of them with the first version this feature is introduced in (e.g. Once this is done, Also, how should user-provided scripts provide this |
I think it might be better not to label those at all. The doctor should be capable of adding the "since" attribute only if adding a new xml item, but not for those that already exist. |
Describe the project you are working on
I'm working on the Godot Engine 4.4 release page.
Describe the problem or limitation you are having in your project
There's a feature that doesn't seem to have been introduced in the Godot 4.4 blog posts, and I want to make sure that this feature is actually new since 4.4 without asking everyone about this, or to manually check merged PRs.
Describe the feature / enhancement and how it helps to overcome the problem or limitation
We should add the introduction date of a feature in the documentation. This would make people more knowledgeable since when a feature exists.
Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams
It would work a lot like Emacs does. Here's an example of the
pixel-scroll-precision-mode
symbol documentation in Emacs 29.4 mentioning since when this mode exists. (I highlighted the line in yellow.)If this enhancement will not be used often, can it be worked around with a few lines of script?
This is core to the class documentation.
Is there a reason why this should be core and not an add-on in the asset library?
This is core to the class documentation.
The text was updated successfully, but these errors were encountered: