Move docstrings above class annotations for better Godot editor integration #410
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Repositioned all class-level docstrings to appear before @tool, @ICON, and class_name annotations across all behavior tree node files, and added missing docstring to
RandomizedComposite.
Why this change was needed
In Godot 4.x, the "Create Node" dialog window displays class documentation to help developers understand what each node does before adding it to their scene. However, Godot's
documentation parser only recognizes docstrings that appear before the class annotations, not after them.
What was changed
Example of the change
Before:
After:
User benefit
Now when developers use Godot's "Create Node" dialog (Ctrl+A), they'll see helpful descriptions for each Beehave node type, making it much easier to understand what each node does
before adding it to their behavior tree. This significantly improves the developer experience and reduces the need to look up documentation separately.
Files affected
All node files in addons/beehave/nodes/ including composites (selectors, sequences, parallel), decorators (cooldown, limiter, inverter, etc.), and leaves (actions, conditions,
blackboard operations).