godot-docs icon indicating copy to clipboard operation
godot-docs copied to clipboard

UndoRedo class page: more elaborate method descriptions and better example code

Open ReturnMinusOne opened this issue 3 years ago • 1 comments

Your Godot version: 3.4.5

Issue description: The documentation for the UndoRedo class is noticeably sparse, with vague method descriptions (see the add_do_property() method for an example) and example code that does literally nothing perceptible.

For someone trying to learn to use UndoRedo for the first time, there are simply too many blanks.

Given the importance and potential complexity of an undo history, I believe there is a strong need to deepen the information available and, more specifically, add sections explaining how to introduce the construction, modification, and deletion of objects into the undo history.

URL to the documentation page (if already existing): https://docs.godotengine.org/en/stable/classes/class_undoredo.html

Thank you.

ReturnMinusOne avatar Aug 04 '22 03:08 ReturnMinusOne

Comparing https://docs.godotengine.org/en/3.3/classes/class_undoredo.html to the stable 4.2 release https://docs.godotengine.org/en/stable/classes/class_undoredo.html I see a lot of the issues addressed, like better descriptions and better example code

lmsonic avatar Jun 07 '24 22:06 lmsonic