-
-
Notifications
You must be signed in to change notification settings - Fork 21.4k
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
Fix GDScript docs not updating when modified externally #97710
Fix GDScript docs not updating when modified externally #97710
Conversation
a87c393
to
f481933
Compare
Am I right that this fixes the documentation update for this specific situation:
I was not able to reproduce the problem in any other situation. I'm not sure it's really a regression because, even before #97168, an opened script was only updated via the Anyway, it seems a good correction. Nice catch!! |
Yes, exactly that and no other situation that I noticed! I did a manual bisect by looking at parent commits but I don't think that was smart, since other possibly relevant PRs that were merged before your commit's parent might've affected it. Going to try to properly bisect it just in case :) |
Ok, so that is the commit that introduced the regression. Specifically, it was removing this piece of code from
It makes sense, since using |
f481933
to
0ad55e9
Compare
Thanks! |
Currently on
master
if you change a GDScript with an external text editor while Godot is open, it will update the script itself but not the documentation. This PR fixes this.It's a minor regression from #97168, which avoids scripts being reloaded twice by removing one of the two loads. Unfortunately it was the one that remembered to add docs to
EditorHelp
. Just made sure the remaining one adds docs.This does highlight a need for us to refactor documentation generation & adding to
EditorHelp
. Perhaps this responsibility should exist within theScript
classes themselves, or at leastScriptServer
. They are the ones that know when documentation has been generated and could add them toEditorHelp
whenTOOLS_ENABLED
.