Skip to content

Streamline input output constraints#137

Open
jo-mueller wants to merge 5 commits into
ome:mainfrom
jo-mueller:streamline-input-output-constraints
Open

Streamline input output constraints#137
jo-mueller wants to merge 5 commits into
ome:mainfrom
jo-mueller:streamline-input-output-constraints

Conversation

@jo-mueller

Copy link
Copy Markdown
Contributor

Fixes ome/ngff#523

This removes some duplicate text and adds more descriptive tables to the transformations section to make the whole paragraph a bit easier to read.

cc @btbest

@jo-mueller jo-mueller added the documentation Improvements or additions to documentation label Jun 10, 2026
@github-actions

Copy link
Copy Markdown

Automated Review URLs

@jo-mueller jo-mueller requested a review from clbarnes June 10, 2026 20:43
Comment thread index.md

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `type` | string | yes | The type of the transformation, which determines the required and optional fields for that transformation. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggestion to replace the "required" column with a "requirement level" (or synonym), with MUST/SHOULD/MAY to match spec text.

Comment thread index.md
|-------|------|----------|-------------|
| `type` | string | yes | The type of the transformation, which determines the required and optional fields for that transformation. |
| `name` | string | no | A unique name for this transformation. |
| `input` | object | yes, unless part of a wrapper transform ([`sequence`](#sequence-md), [`bijection`](#bijection-md), [`byDimension`](#bydimension-md)) | The input coordinate system for this transformation. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The Type column, where the type is another object defined in this spec, should use that object's name and link to its definition. But we shouldn't try to change all the definitions into tables in this PR :)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It was tempting 😬 🙈

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

RFC-5: Type inconsistency on nested transform input/output

2 participants