Skip to content

Commit a8e6246

Browse files
hyanwongjeromekelleher
authored andcommitted
Correct type of metadata array attribute in struct metadata docs
1 parent 8caf830 commit a8e6246

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/metadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -658,7 +658,7 @@ Metadata processing can be disabled and raw bytes stored/retrieved. See
658658
## Structured array metadata
659659

660660
If the `struct` codec is used for metadata then the metadata can be very efficiently
661-
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:
661+
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:
662662

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

0 commit comments

Comments
 (0)