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

Docs talk about removed "Leaf types" #55044

Open
Seelengrab opened this issue Jul 5, 2024 · 2 comments
Open

Docs talk about removed "Leaf types" #55044

Seelengrab opened this issue Jul 5, 2024 · 2 comments
Labels
domain:docs This change adds or pertains to documentation

Comments

@Seelengrab
Copy link
Contributor

Seelengrab commented Jul 5, 2024

isleaftype was removed in 2018 in #25496, but unfortunately the FFI docs still refer to the concept:

| `mutable struct` | `BitSet` | "Leaf Type" :: A group of related data that includes a type-tag, is managed by the Julia GC, and is defined by object-identity. The type parameters of a leaf type must be fully defined (no `TypeVars` are allowed) in order for the instance to be constructed. |

| `struct ...; end` | `nothing` | "Singleton" :: a Leaf Type or Struct with no fields. |

* `T`, where `T` is a Julia leaf type

* `T`, where `T` is a Julia Leaf Type

As do the performance tips:

The following examples may help you interpret expressions marked as containing non-leaf types:

* Interpretation: getting a field that is of non-leaf type. In this case, the type of `x`, say `ArrayContainer`, had a

The performance docs are particularly unfortunate, because they don't introduce the term and don't point to another place that has a correct definition. Further, since "leaf type-ness" is not queryable anymore, the ccalling docs end up being a bit confusing in terms of what a corresponding type would even be.

There's this comment by @vtjnash clarifying the situation back when this was decided, so that'd be a good starting point for finding a wording that is both accurate & uses up-to-date terminology.

@Seelengrab Seelengrab added the domain:docs This change adds or pertains to documentation label Jul 5, 2024
@vtjnash
Copy link
Sponsor Member

vtjnash commented Jul 5, 2024

That looks like it should have been corrected to say isconcretetype at the time

@Seelengrab
Copy link
Contributor Author

In both the FFI docs & performance tips?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation
Projects
None yet
Development

No branches or pull requests

2 participants