Skip to content

Commit 8de3e5a

Browse files
authored
Merge pull request #11512 from bruvzg/split_val
Update docs for GDExtensions validation.
2 parents 999daec + 67f9442 commit 8de3e5a

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

engine_details/development/handling_compatibility_breakages.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -114,12 +114,11 @@ Next, this should be included in the ``.cpp`` file we're adding compatibility me
114114
115115
#include "core/variant/typed_array.h"
116116
117-
And finally, the changes reported by the API validation step should be added to the relevant validation file. Because this was
118-
done during the development of 4.3, this would be ``misc/extension_api_validation/4.2-stable.expected`` (including changes not shown in
119-
this example):
117+
And finally, the changes reported by the API validation step should be added to a validation file. Because this was
118+
done during the development of 4.3, the validation file would be in the ``misc/extension_api_validation/4.2-stable/`` folder:
120119

121120
.. code-block:: text
122-
:caption: misc/extension_api_validation/4.2-stable.expected
121+
:caption: misc/extension_api_validation/4.2-stable/GH-88047.txt
123122
124123
GH-88047
125124
--------
@@ -133,10 +132,8 @@ this example):
133132
Added optional "allow_partial_path" argument to get_id_path and get_point_path methods in AStar classes.
134133
Compatibility methods registered.
135134
136-
The instructions for how to add to that file are at the top of the file itself.
137-
138135
If you get a "Hash changed" error for a method, it means that the compatibility binding is missing or incorrect.
139-
Such lines shouldn't be added to the ``.expected`` file, but fixed by binding the proper compatibility method.
136+
Such lines shouldn't be added to the validation file, but fixed by binding the proper compatibility method.
140137

141138
And that's it! You might run into a bit more complicated cases, like rearranging arguments,
142139
changing return types, etc., but this covers the basic on how to use this system.

0 commit comments

Comments
 (0)