godotengine / godotengine/godot-docs
No instance of `_get_configuration_warnings()` contains any examples or reference to proper usage
- Dominant language
- reStructuredText
- Stars
- 5.7k
- Forks
- 3.8k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 25
Description
**Your Godot version:**
Godot 4.0.1
Latest Documentation
**Issue description:**
Documentation for `_get_configuration_warnings()` contains a cyclical reference to `update_configuration_warnings()` and neither provide references to examples for intended use.
I think I encountered a bug while using it, but I genuinely can't say so with certainty because the documentation does not describe how to actually use either of these function properly. The lack of documentation on this means that as a learner I have genuinely nothing to fact check my discovery against to verify it.
Searching for `_get_configuration_warnings()` only returns the Overridable Functions tutorial and the Scripting reference for Node
**URL to the documentation page (if already existing):**
https://docs.godotengine.org/en/latest/tutorials/scripting/overridable_functions.html#overridable-functions
https://docs.godotengine.org/en/latest/classes/class_node.html#class-node-method-get-configuration-warnings
https://docs.godotengine.org/en/latest/classes/class_node.html#class-node-method-update-configuration-warnings
https://docs.godotengine.org/en/latest/search.html?q=_get_configuration_warnings%28%29&check_keywords=yes&area=default
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.