Incomplete space/index iterator documentation
Open
@Totktonada is already working on this.
Since May 20, 2022.
add details
reference
server
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Motivation
Methods space.pairs and index.pairs return an iterator that might be used with for-in loop, as stated in documentation. However there is no information about the structure and origin of the provided iterator (in both en and ru versions).
Suggestion
Please insert links to the luafun documentation, that describe iterator structure, iterator_mt metatable functions or at least mention that luafun methods are available to use.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.