seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #112638 from dalexeev/editor-help-bit-add-missing-packed-array-warning

Browse Source 
Add missing warning about copying packed arrays to `EditorHelpBit`
This commit is contained in:
Thaddeus Crews
2025-11-11 16:07:57 -06:00
parent 180ccae934 0b20ae2e87
commit e47fb8b898
2 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/tools/make_rst.py
View File

@ -87,6 +87,7 @@ BASE_STRINGS = [
"This method may be changed or removed in future versions.",
"This operator may be changed or removed in future versions.",
"This theme property may be changed or removed in future versions.",
# See also `make_rst_class()` and `editor/doc/editor_help.cpp`.
"[b]Note:[/b] The returned array is [i]copied[/i] and any changes to it will not update the original property value. See [%s] for more details.",
]
strings_l10n: Dict[str, str] = {}
@ -1303,6 +1304,7 @@ def make_rst_class(class_def: ClassDef, state: State, dry_run: bool, output_dir:
# Add copy note to built-in properties returning `Packed*Array`.
if property_def.type_name.type_name in PACKED_ARRAY_TYPES:
# See also `BASE_STRINGS` and `editor/doc/editor_help.cpp`.
copy_note = f"[b]Note:[/b] The returned array is [i]copied[/i] and any changes to it will not update the original property value. See [{property_def.type_name.type_name}] for more details."
f.write(f"{format_text_block(copy_note, property_def, state)}\n\n")