This is a minor language clarification to switch from saying that this example is the "expected" layout to saying that it is a valid example.
I have made this change because I think "expected" could be interpreted as "this is what the spec says your layout should be", but I think the intent here was actually "here's a useful example of what a typical layout would be".
Note that I also added a new changelog section to the spec, because changes like this should get a changelog entry (see https://github.com/ome/ngff/issues/275). This is just so I don't forget to include a changelog somewhere, and not an assumption on what the final location/format of that changelog will be, which can be discussed in https://github.com/ome/ngff/issues/275.
github-actions[bot]
commented
1 week ago
This is a minor language clarification to switch from saying that this example is the "expected" layout to saying that it is a valid example.
I have made this change because I think "expected" could be interpreted as "this is what the spec says your layout should be", but I think the intent here was actually "here's a useful example of what a typical layout would be".
Note that I also added a new changelog section to the spec, because changes like this should get a changelog entry (see https://github.com/ome/ngff/issues/275). This is just so I don't forget to include a changelog somewhere, and not an assumption on what the final location/format of that changelog will be, which can be discussed in https://github.com/ome/ngff/issues/275.