Clarify that io.readdir handles are iterated with lines() - #594
Open
marcellotmartins wants to merge 1 commit into
Open
Clarify that io.readdir handles are iterated with lines()#594marcellotmartins wants to merge 1 commit into
marcellotmartins wants to merge 1 commit into
Conversation
The directory listing example already used the handle's lines() iterator, but never stated that the handle is not a plain table and therefore cannot be iterated with ipairs or pairs. Add a short note before the iteration example to prevent that common confusion. Closes citizenfx#518.
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
1 participant
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.
The directory listing example in the sandbox docs already used the handle's
lines()iterator, but never stated that the returned value is a handle (not a plain table) and therefore cannot be iterated withipairsorpairs.This adds a short sentence before the iteration example to prevent that common confusion.
Closes #518.