Skip to content

reorder fields in a more logical way#2725

Closed
nlharris wants to merge 1 commit intomasterfrom
nlharris-patch-2
Closed

reorder fields in a more logical way#2725
nlharris wants to merge 1 commit intomasterfrom
nlharris-patch-2

Conversation

@nlharris
Copy link
Copy Markdown
Contributor

why did these records start with affiliation, with name buried somewhere in the middle? that makes it much tricker to correctly make edits (adding or removing someone).

i reordered the fields (with the help of a Claude-generated script) to put name first and affiliation list, in hopes of making this file more maintainable both in the short term (i need to move some members to alumni) and longer term.

lmk if anything looks wonky; i only spot-checked.

why did these records start with affiliation, with name buried somewhere in the middle? that makes it much tricker to correctly make edits (adding or removing someone).

i reordered the fields (with the help of a Claude-generated script) to put name first and affiliation list, in hopes of making this file more maintainable both in the short term (i need to move some members to alumni) and longer term.

lmk if anything looks wonky; i only spot-checked.
@nlharris
Copy link
Copy Markdown
Contributor Author

i'm not sure why the tests failed - was there some sort of syntax error? (do extra spaces at the ends of lines matter?) or were the tests checking that the fields were ordered in the old way?

@jsstevenson
Copy link
Copy Markdown
Contributor

jsstevenson commented May 30, 2025

I'm just eyeballing this, but I believe that the failing test checks for equality against the input YAML but it sorts the keys for each item. In other words, it checks that the input items all have alphabetically-sorted keys (which is why 'name' isn't first). Agree that this would be nice to change.

@matentzn
Copy link
Copy Markdown
Contributor

We have worked a long time to standardise the metadata records to make give as little and attack surface as possible (bugs etc). So we chose to just apply alpha numerical sort ordering for everything. I think its best we keep it that way, because implementing another sort order in the QC will be very cumbersome, and the YAML files are NOT for human consumption

@nlharris
Copy link
Copy Markdown
Contributor Author

implementing another sort order in the QC will be very cumbersome, and the YAML files are NOT for human consumption

ok, but humans are the ones who have to update this file to add/remove people, and the current weird ordering is cumbersome and error-prone for humans. i understand the reasoning, though, and will deal.

@matentzn
Copy link
Copy Markdown
Contributor

You can make an issue about it, maybe I can ask someone to find a way.

@nlharris
Copy link
Copy Markdown
Contributor Author

Closing this PR; see issue #2727

@nlharris nlharris closed this May 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants