Skip to content

Mention the new type system in typespecs doc #14188

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

Merged
merged 2 commits into from
Jan 15, 2025

Conversation

sabiwara
Copy link
Contributor

This discussion made me realize that today the doc for typespecs does not call out the fact this is the "old typesystem" and it doesn't represent the upcoming type system.

I can see how this might be confusing for people who haven't followed the type system discussions closely or are learning Elixir, and do not realize a) that these two are separate b) how they relate/differ

Screenshot 2025-01-15 at 9 05 56 Screenshot 2025-01-15 at 9 06 07

Feel free to modify the copy.

Comment on lines 3 to 5
Elixir is in the process of implementing its [own type system](./gradual-set-theoretic-types.md) based on set-theoretic types. Typespecs, which are described in the following document, are a distinct notation for declaring types and specifications based on Erlang.

Typespecs will be phased out as the set-theoretic type effort moves forward.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Elixir is in the process of implementing its [own type system](./gradual-set-theoretic-types.md) based on set-theoretic types. Typespecs, which are described in the following document, are a distinct notation for declaring types and specifications based on Erlang.
Typespecs will be phased out as the set-theoretic type effort moves forward.
> Elixir is in the process of implementing its [own type system](./gradual-set-theoretic-types.md) based on set-theoretic types. Typespecs, which are described in the following document, are a distinct notation for declaring types and specifications based on Erlang. Typespecs may be phased out as the set-theoretic type effort moves forward.

@josevalim
Copy link
Member

Feel free to merge and, once you do, please backport!

@sabiwara sabiwara merged commit c592252 into elixir-lang:main Jan 15, 2025
1 check passed
@sabiwara sabiwara deleted the doc-types branch January 15, 2025 11:41
sabiwara added a commit to sabiwara/elixir that referenced this pull request Jan 15, 2025
@sabiwara
Copy link
Contributor Author

once you do, please backport!

Done ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants