godotengine / godotengine/godot-docs

Mention error_string() in the Error enum docs

Open Beginner friendly
#10,777 0 comments 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:** 4.4

**Issue description:**

I found the Error enum from following a link in the editor. Trying to search the web or the docs site for "error" was much less helpful. So it took me a while (and one partially written Discord help thread) before I searched in page and found [error_string()](https://docs.godotengine.org/en/stable/classes/class_@globalscope.html#class-globalscope-method-error-string). I think it would be useful to mention and link to this under the Error enum docs.

Absent an obvious solution, seeing Error was an enum sent me on a wild goose chase trying to figure out how to look up enum names (and finding examples using keys() which doesn't work anymore)

**URL to the documentation page (if already existing):**

https://docs.godotengine.org/en/stable/classes/class_@globalscope.html#enum-globalscope-error

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at the Error enum section on the linked GlobalScope documentation page and inspect the surrounding reStructuredText source. Add a mention and link for error_string() there, then build or preview the documentation to confirm the link and wording appear under the Error enum docs.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.