Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename and sort the modules in the feature profiles table for easier skimming #1855

Merged
merged 3 commits into from
Jun 26, 2024

Conversation

Johennes
Copy link
Contributor

@Johennes Johennes commented Jun 10, 2024

This renames the modules in the table to match the section titles and orders the table alphabetically within the two subsections of modules with and without requirements.

Adding the modules that were missing in v1.10 has been moved out into #1860.

Fixes: #1437

Pull Request Checklist

Preview: https://pr1855--matrix-spec-previews.netlify.app

@Johennes Johennes marked this pull request as ready for review June 10, 2024 12:15
@Johennes Johennes requested a review from a team as a code owner June 10, 2024 12:15
Copy link
Member

@turt2live turt2live left a comment

Choose a reason for hiding this comment

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

Thanks! I'd suggest we split out the adding and resorting to their own PRs. It's not immediately clear to me that this is the ordering we'd want (previously it was loosely ordered on "required-ness"). Adding the missing stuff is certainly important, though.

@Johennes
Copy link
Contributor Author

Ok, I can do that. Where would you suggest I insert the missing modules in the existing order?

@turt2live
Copy link
Member

We typically just append them to the end, for better or worse. If they're "required" (they shouldn't be), put them under the existing required ones.

@Johennes Johennes marked this pull request as draft June 11, 2024 10:49
@Johennes
Copy link
Contributor Author

I pushed #1860 which merely adds the three missing modules without touching the table ordering.

@Johennes Johennes changed the title Add missing modules to feature profiles Reorder modules table for feature profiles Jun 11, 2024
@Johennes Johennes changed the title Reorder modules table for feature profiles Rename and sort the modules in the feature profiles table for easier skimming Jun 13, 2024
@Johennes
Copy link
Contributor Author

The brief discussion in the matrix-spec room was, sadly, inconclusive. The suggested options so far are:

  1. Sort alphabetically
  2. Sort by section occurrence
  3. Sort by requiredness (this is more or less how the table is sorted currently)
  4. Sort by requiredness first and alphabetically second

As a middleground, I updated the PR to match option 4 but also renamed those rows where the module name didn't match the section title. This should hopefully still make it easy enough to cross-reference the table with the sections.

For convenience, the PR can be reviewed by commit:

@Johennes Johennes marked this pull request as ready for review June 13, 2024 10:54
@Johennes Johennes requested a review from turt2live June 13, 2024 10:54
@Johennes
Copy link
Contributor Author

CC @uhoreg / @anoadragon453 since you participated in the chat in matrix-spec.

Copy link
Member

@turt2live turt2live left a comment

Choose a reason for hiding this comment

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

I'm going to abstain from reviewing this one - the order doesn't bother me.

@turt2live turt2live requested a review from a team June 25, 2024 23:08
@clokep clokep merged commit d7299b5 into matrix-org:main Jun 26, 2024
12 checks passed
@zecakeh zecakeh mentioned this pull request Sep 5, 2024
41 tasks
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.

Missing modules in Feature Profiles
3 participants