godotengine / godotengine/godot-docs

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

Open
#6,027 1 comment 0 reactions 0 assignees View on GitHub
area:class reference enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**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()](https://docs.godotengine.org/en/stable/classes/class_undoredo.html#class-undoredo-method-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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.