godotengine / godotengine/godot-docs

UndoRedo documentation lacks information about 800ms interval, and needs clarfication on merging

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

Description

**Your Godot version:** 4.2.rc

**Issue description:**

UndoRedo documentation is lacking information about how merging of actions work. It only gives a brief overview of MERGE_DISABLE, MERGE_ENDS and MERGE_ALL and doesn't give any code examples on how their behaviour differs. In order to fully understand intended behaviour, I made my own chart:

![image](https://github.com/godotengine/godot-docs/assets/3089525/f21027d2-b059-4ffb-815b-f1302d0491a9)

Also of note is that the documentation makes no mention that actions have to take place within 800ms of eachother in order to be merged. I've seen multiple people being surprised by this behavior, including code contributors.

**URL to the documentation page:** https://docs.godotengine.org/en/stable/classes/class_undoredo.html

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.