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

AI and Dataset: Sort entries A-Z #713

Merged
merged 1 commit into from
Apr 14, 2024
Merged

Conversation

bact
Copy link
Collaborator

@bact bact commented Apr 12, 2024

As some lists are getting long and it is inconvenient to find an entry in an unsorted list.

Sorting rules:

  • Do not alphabetically sort the list that is already semantically sorted, such as by level of intensity (as in SafetyRiskAssessmentType, ConfidentialityLevelType, DatasetAvailabilityType)
  • Sort A-Z
  • Keep other and noAssertion at the end of the list

Sorting rules:
- Do not alphabetically sort the list that is already semantically sorted, such as by level of intensity (as in SafetyRiskAssessmentType, ConfidentialityLevelType, DatasetAvailabilityType)
- Sort A-Z
- `other` and `noAssertion` at the end of the list
@bact
Copy link
Collaborator Author

bact commented Apr 12, 2024

@rgopikrishnan91 @bennetkl would you mind reviewing this please. Thank you.

@zvr
Copy link
Member

zvr commented Apr 12, 2024

I don't object, as long as it is understood what is being done.

For reference reasons sorted is better for the use case of finding something. It also saves us all the trouble about deciding which should be the "correct" order, to never show any preference between options (e.g. algorithms), etc.
That's why the order of the input files is ignored and generated files are always sorted: in the contents classes, properties, etc. appear in alphabetical order, and inside each one properties, vocabulary entries, etc. (essentially every list/table) are also in alphabetical order.

Therefore, this PR is OK if you want the model files to be in this order for editing, but realize that this will not be reflected in the generated spec.

@bact
Copy link
Collaborator Author

bact commented Apr 12, 2024

Thank you @zvr . Yes, it's for the editing purpose.

I came up to this after I was trying to check the diagrams and found that the unsorted lists in Markdown files are not really facilitating the job.

Copy link
Contributor

@kestewart kestewart left a comment

Choose a reason for hiding this comment

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

Thanks @bact for adding the ordering.

@kestewart kestewart added this to the 3.0 milestone Apr 12, 2024
Copy link
Member

@goneall goneall left a comment

Choose a reason for hiding this comment

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

LGTM

@goneall goneall merged commit b5cad6a into spdx:main Apr 14, 2024
1 check passed
@bact bact deleted the sort-entries-ai-dataset branch April 15, 2024 06:14
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.

4 participants