godotengine / godotengine/godot-docs

GDScript's load() method has an innaccurate/misleading sentence in the description.

Open
#9,843 1 comment 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.3**

**Issue description: The description for GDScript's load() has the following sentence: "To avoid unnecessary delays when loading something multiple times, either store the resource in a variable or use preload." This is contradicted by the fact that load() uses ResourceLoader.CACHE_MODE_REUSE, therefore "loading something multiple times" would simply fetch from the cache and incur no unnecessary delays. As it stands, the documentation recommends to re-implement a cache on top of an already cached value.
I would propose to erase it entirely or replace the sentence with a slightly different one, like "To avoid unwanted delays when loading something for the first time, either load it earlier and store the resource in a variable, or use preload."**

**URL to the documentation page: https://docs.godotengine.org/en/stable/classes/class_%40gdscript.html#class-gdscript-method-load**

If you know how to fix the issue you are reporting please
consider opening a pull request. We provide a tutorial on
using git here: https://docs.godotengine.org/en/stable/community/contributing/pr_workflow.html,
writing documentation at https://docs.godotengine.org/en/stable/community/contributing/docs_writing_guidelines.html
and contributing to the class reference here: https://docs.godotengine.org/en/stable/community/contributing/updating_the_class_reference.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.