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

Improve docs about plugin registration #53836

Merged
merged 1 commit into from
Oct 18, 2021

Conversation

KoBeWi
Copy link
Member

@KoBeWi KoBeWi commented Oct 15, 2021

Closes godotengine/godot-proposals#195
The docs for EditorExportPlugin were filled, but they didn't mention the most important thing - that you need to register the plugin for any method to be called.

I also made the same changes to other similar plugins, unifying it a bit.

@KoBeWi KoBeWi added enhancement documentation topic:plugin cherrypick:3.x Considered for cherry-picking into a future 3.x release labels Oct 15, 2021
@KoBeWi KoBeWi added this to the 4.0 milestone Oct 15, 2021
@KoBeWi KoBeWi requested a review from a team as a code owner October 15, 2021 12:33
Copy link
Contributor

@YuriSizov YuriSizov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can take this opportunity to unify the descriptions even further. But otherwise seems good.

doc/classes/EditorDebuggerPlugin.xml Outdated Show resolved Hide resolved
doc/classes/EditorExportPlugin.xml Outdated Show resolved Hide resolved
doc/classes/EditorImportPlugin.xml Outdated Show resolved Hide resolved
doc/classes/EditorInspectorPlugin.xml Outdated Show resolved Hide resolved
doc/classes/EditorNode3DGizmoPlugin.xml Outdated Show resolved Hide resolved
doc/classes/EditorSceneImporter.xml Outdated Show resolved Hide resolved
doc/classes/EditorTranslationParserPlugin.xml Outdated Show resolved Hide resolved
doc/classes/EditorDebuggerPlugin.xml Outdated Show resolved Hide resolved
doc/classes/EditorDebuggerPlugin.xml Outdated Show resolved Hide resolved
doc/classes/EditorDebuggerPlugin.xml Outdated Show resolved Hide resolved
doc/classes/EditorDebuggerPlugin.xml Outdated Show resolved Hide resolved
doc/classes/EditorExportPlugin.xml Outdated Show resolved Hide resolved
@KoBeWi KoBeWi force-pushed the register_before_use branch from bea1bd5 to 684995e Compare October 16, 2021 22:48
@KoBeWi KoBeWi force-pushed the register_before_use branch from 684995e to 7515af8 Compare October 16, 2021 23:52
Copy link
Contributor

@YuriSizov YuriSizov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pluralizing cross-references like that often looks ugly and doesn't help with localizations, but it's not critical right now. 🙃

@akien-mga akien-mga merged commit 231d38c into godotengine:master Oct 18, 2021
@akien-mga
Copy link
Member

Thanks!

@KoBeWi KoBeWi deleted the register_before_use branch October 18, 2021 09:02
@akien-mga
Copy link
Member

This could use a dedicated cherry-pick PR, there's a number of conflicts and renamed classes to handle.

@KoBeWi KoBeWi removed the cherrypick:3.x Considered for cherry-picking into a future 3.x release label Dec 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add support for running pre- and post-export scripts
5 participants