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

Julia v1.11-rc1: Iterators.Stateful docstrings suggest it is an internal binding #55056

Open
RoyCCWang opened this issue Jul 6, 2024 · 1 comment

Comments

@RoyCCWang
Copy link

RoyCCWang commented Jul 6, 2024

My REPL shows the following before the usual docstring for Iterators.Stateful:

help?> Iterators.Stateful
  │ Warning
  │
  │  The following bindings may be internal; they may change or be removed in future versions:
  │
  │    •  Base.Iterators.Stateful

On Julia v1.10.4, I do not get this warning when viewing the docstring for Iterators.Stateful.

I see a few open issues involving stateful iterators, and proposals for an IsStateful trait in #43388.

Please advise the Julia community in the v1.11 release notes if Iterators.Stateful ends up being deprecated in the official v1.11 release. I suggest having some compact examples of what not to do when using Iterators.Stateful, either in its docstring or via a blog post on the Julia official website.

@nsajko nsajko added docs This change adds or pertains to documentation and removed docs This change adds or pertains to documentation labels Jul 7, 2024
@nsajko
Copy link
Contributor

nsajko commented Jul 7, 2024

See #51335

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

No branches or pull requests

2 participants