Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EditorSettings doc is not present inside the editor when using doc cache #77878

Closed
YeldhamDev opened this issue Jun 5, 2023 · 4 comments · Fixed by #78615
Closed

EditorSettings doc is not present inside the editor when using doc cache #77878

YeldhamDev opened this issue Jun 5, 2023 · 4 comments · Fixed by #78615

Comments

@YeldhamDev
Copy link
Member

Godot version

4.0.dev [0f76ff2]

System information

Kubuntu GNU/Linux 23.04

Issue description

In the current master (stable seems fine), the EditorSettings doc is nowhere to be found in the editor, even though it exists: https://github.com/godotengine/godot/blob/master/doc/classes/EditorSettings.xml

Steps to reproduce

Search for "EditorSettings" in the help dialog, or try clicking in a reference to it.

Minimal reproduction project

N/A

@YuriSizov
Copy link
Contributor

YuriSizov commented Jun 5, 2023

Deleting editor_data/cache/editor.doc_cache manually solves the problem for me. No idea why EditorSettings went missing in the first place (and at which point it went missing). Also no idea why this cache is considered valid.

cc @RandomShaper

@RandomShaper
Copy link
Member

I'm not being able to reproduce this nor analytically find what can be failing in the code for either the class to be missing or the cache to be considered valid.

@akien-mga
Copy link
Member

I can reproduce the issue locally, including with 4.1.beta3.official. It seems like
Deleting ~/.cache/godot/editor.doc_cache solves it for the next restart, but then opening a different Godot version with that pre-existing cache will trigger the issue again.

For example, steps to reproduce:

  • Delete ~/.cache/godot/editor.doc_cache
  • Open Godot 4.1.beta3.official, check that EditorSettings is in the docs - it's there
  • Close it
  • Open Godot 4.1.beta2.official, check that EditorSettings is in the docs - it's missing
  • Close it
  • Delete ~/.cache/godot/editor.doc_cache
  • Open Godot 4.1.beta2.official, check that EditorSettings is in the docs - it's there
  • Close it
  • Open Godot 4.1.beta3.official, check that EditorSettings is in the docs - it's missing

The same happens testing with a build from latest master and 4.1.beta3.official.

Given how close we are to RC 1, and that the doc caching is not a major improvement, I suggest we disable it for now until it's fixed.

@akien-mga
Copy link
Member

#78614 alleviates this for 4.1, so bumping milestone for actually fixing the underlying issue to 4.2.

@akien-mga akien-mga changed the title EditorSettings doc is not present inside the editor EditorSettings doc is not present inside the editor when using doc cache Jun 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants