Add warning to Object._iter_init docs about using alternative state#118102
Open
aurpine wants to merge 1 commit intogodotengine:masterfrom
Open
Add warning to Object._iter_init docs about using alternative state#118102aurpine wants to merge 1 commit intogodotengine:masterfrom
Object._iter_init docs about using alternative state#118102aurpine wants to merge 1 commit intogodotengine:masterfrom
Conversation
Member
|
Perhaps it would be better not just to remove the mention of the alternative, but to add a note explaining why you shouldn't use this approach (nested loops)? Also, would it be worth keeping a link to the online documentation, in case it explains the iterator API in a bit more detail? |
Author
|
Added a section explaining the alternative. Maybe we could move this to the tutorial page instead to keep the class reference lean? |
dalexeev
reviewed
Apr 2, 2026
Member
|
Please squash commits into one. To do this you need a local git client, GitHub web interface doesn't support it. It might also make sense to update the commit message and PR title, given that you're no longer removing the mention, but emphasizing that this is a less desirable approach. |
6fde622 to
3f8e17d
Compare
Object._iter_init docs mentioning alternative iterator stateObject._iter_init docs about using alternative state
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This follows the update in godotengine/godot-docs#11901 that will remove the technique referenced in
Object._iter_initdocs. It is replaced with a warning about not using theiterparameter.