Skip to content

Correct type of metadata array attribute in struct metadata docs #3185

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.

Sign up for GitHub

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
jeromekelleher merged 1 commit into from
May 30, 2025
Merged

Correct type of metadata array attribute in struct metadata docs #3185

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -658,7 +658,7 @@ Metadata processing can be disabled and raw bytes stored/retrieved. See
## Structured array metadata

If the `struct` codec is used for metadata then the metadata can be very efficiently
accessed via a `numpy` [structured array](https://numpy.org/doc/stable/user/basics.rec.html) via the `ts.X_metadata` property, e.g. {meth}`TreeSequence.individuals_metadata`. The codec must meet the following requirements for this to work:
accessed via a `numpy` [structured array](https://numpy.org/doc/stable/user/basics.rec.html) via the `ts.X_metadata` property, e.g. {attr}`TreeSequence.individuals_metadata`. The codec must meet the following requirements for this to work:

1. The metadata for a given object must be of a fixed size. This means that
variable length arrays are not permitted, such that the `length` property
Expand Down
Loading