Skip to content

Conversation

thompson-tomo
Copy link
Contributor

@thompson-tomo thompson-tomo commented Oct 4, 2025

Fixes #2824

Changes

The attribute tables have been re-organised in the following manner:

  • Attribute heading added above attribute tables to provide guidance as to what the table is and helps when multiple tables are rendered alongside one another
  • Attribute column heading renamed to Key as it relates to the key of the attribute which is a row
  • Examples column heading renamed to Example Values as it relates to the value of the attribute rather than an attribute
  • Type column heading renamed to Value Type as it relates to the type expected of the value rather than an attribute
  • Description column heading renamed to Summary as it should be a brief summary of what it is.
  • Requirement and stability moved to be after key to give increased focus

Note: if the PR is touching an area that is not listed in the existing areas, or the area does not have sufficient domain experts coverage, the PR might be tagged as experts needed and move slowly until experts are identified.

Merge requirement checklist

  • CONTRIBUTING.md guidelines followed.
  • Change log entry added, according to the guidelines in When to add a changelog entry.
    • If your PR does not need a change log, start the PR title with [chore]
  • Links to the prototypes or existing instrumentations (when adding or changing conventions)

@thompson-tomo thompson-tomo force-pushed the chore/#2824_NewColumnOrder branch from fc53148 to fc625d9 Compare October 12, 2025 01:13
@trask
Copy link
Member

trask commented Oct 13, 2025

Examples of new layout, anywhere there's an attribute table.

Stability and Requirement level have been moved closed to the beginning, and a couple of column renames:

image

@kamphaus
Copy link
Contributor

I think we should have either Summary or Description for both:
image

@thompson-tomo
Copy link
Contributor Author

thompson-tomo commented Oct 13, 2025

@kamphaus i agree that in the end they should match. I was planning to update the signal property headings/labels is in a follow up pr to not change too much here. That pr would also standardise title casing & : for all labels. I will raise that later this week and link the 2 pr's.

Unless @trask things it would be better to have 1 bigger pr to cover both.

@trask
Copy link
Member

trask commented Oct 13, 2025

I'd suggest leaving it as Description in this PR, and you can follow up later with a PR to propose changing them both at the same time

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

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

Reorder columns in markdown tables: prioritize stability and req levels

4 participants