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

Dataset: Rename Dataset class to DatasetPackage and update properties desc. #671

Merged
merged 12 commits into from
Mar 27, 2024

Conversation

bact
Copy link
Collaborator

@bact bact commented Mar 21, 2024

Rename Dataset class to DatasetPackage:

  • To fix Dataset: Is it a Dataset class or a DatasetPackage class? #657 to maintain consistency (consensus reached in AI Team Meeting 6 March 2024)
  • Update the label in the diagram model.drawio accordingly
  • Update descriptions of Dataset.md, DatasetPackage.md, AI.md, AIPackage.md to reflect the new DatasetPackage name.
    • Also differentiate between the Profile and the xxPackage class.

Update other property descriptions:

  • Remove the property names from the beginning of the first paragraph in the description.
    • This is to avoid confusion about actual casing
    • For example, autonomyType (actual property name) vs "AutonomyType" (the mention of the property in the beginning of the paragraph).
      • The first one is camelCase (small A at the beginning), the latter is PascalCase (capital A).
    • There was at least one inconsistency as well. datasetType was mentioned as "Type". Removing the mention also fixed the inconsistency.
  • For properties with Range: xsd:string, add "A free form text that ..." to the description.
  • Remove trailing spaces at the end of lines and newlines at the end of files.

@bact
Copy link
Collaborator Author

bact commented Mar 21, 2024

@kestewart please kindly review.

Some changes (description editing) are opportunistic, I can remove them to make the change set more minimal.

fyi @rgopikrishnan91 @bennetkl I have moved the PR here after trying resolve merge conflicts.

model/AI/AI.md Outdated Show resolved Hide resolved
model/AI/AI.md Outdated Show resolved Hide resolved
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 for the cleanup.

@kestewart kestewart added this to the 3.0-rc3 milestone Mar 26, 2024
@bact bact changed the title [3.0] Dataset: Rename Dataset class to DatasetPackage and update properties desc. Dataset: Rename Dataset class to DatasetPackage and update properties desc. Mar 27, 2024
@rgopikrishnan91
Copy link
Contributor

Looks good to me. I think can be merged. Thanks @bact !

@kestewart kestewart merged commit 7b75e5f into spdx:main Mar 27, 2024
1 check passed
@kestewart
Copy link
Contributor

Gopi's ok is in comments, so going ahead and merging.

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

Successfully merging this pull request may close these issues.

Dataset: Is it a Dataset class or a DatasetPackage class?
4 participants