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

Clarify the sense in which Nim supports recursive iterators in docs #15834

Merged
merged 1 commit into from
Nov 4, 2020

Conversation

c-blake
Copy link
Contributor

@c-blake c-blake commented Nov 3, 2020

Fix manual, tutorial, and tbintree test comments to not mislead so much about lack of recursive iterator support. This has confused quite few people over the years.

See cblake & others comments in (at least!):
https://forum.nim-lang.org/t/7020
https://forum.nim-lang.org/t/6649
https://forum.nim-lang.org/t/6393
https://forum.nim-lang.org/t/5047
but probably more and probably a lot in the IRC as well.

manual, the tutorial, and the `tbintree` test.
@c-blake
Copy link
Contributor Author

c-blake commented Nov 3, 2020

Tagging @mratsim who might have a critique on language used. The simplest possible language may be "but Nim supports recursive iterator factories which are good enough/better via explicitness", but that only makes sense after someone understands iterator factories.

Also, the CI failure is just some tests/vm/tslow_tables.nim which cannot possibly be related to the comment-only/doc only changes.

@c-blake
Copy link
Contributor Author

c-blake commented Nov 4, 2020

Also, if you want, we could make the toItr example more general with a probable trade-off for ease of understanding.

@Araq
Copy link
Member

Araq commented Nov 4, 2020

Good enough for me.

@Araq Araq merged commit f175557 into nim-lang:devel Nov 4, 2020
@c-blake c-blake deleted the AddMacroToIteratorDocs branch November 4, 2020 15:57
narimiran pushed a commit that referenced this pull request Nov 5, 2020
…15834)

manual, the tutorial, and the `tbintree` test.

(cherry picked from commit f175557)
PMunch pushed a commit to PMunch/Nim that referenced this pull request Jan 6, 2021
mildred pushed a commit to mildred/Nim that referenced this pull request Jan 11, 2021
irdassis pushed a commit to irdassis/Nim that referenced this pull request Mar 16, 2021
ardek66 pushed a commit to ardek66/Nim that referenced this pull request Mar 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants