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

Fix typos: hasPrerequsite -> hasPrerequisite, and others #817

Merged
merged 3 commits into from
Aug 6, 2024

Conversation

bact
Copy link
Collaborator

@bact bact commented Jul 30, 2024

  • Fix typo in hasAddedFile: "is is" -> "is"
  • Fix typo in type name: "hasPrerequsite" -> "hasPrerequisite"
  • Make fullstops and commas in of all types in RelationshipType consistent.
    • some "during a LifecycleScopeType period" have comman before it, some don't
    • some description with one sentence have fullstop, some don't

Also make fullstops and commas consistent.

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact bact changed the title hasAddedFile: Remove double is ("is is" -> "is") hasAddedFile: Fix typo: "is is" -> "is" Jul 30, 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

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Copy link
Collaborator Author

bact commented Jul 31, 2024

@goneall I have pushed another commit after your approval to fix: hasPrerequsite -> hasPrerequisite.

There's a typo of this hasPrerequisite relationship type as well in the 2.3->3.0 translation table. I will open another PR to fix that together with the strikethrough formatting. (opened at spdx/spdx-spec#1017 )

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.

Good catch @bact

This could be a breaking change if anyone is using the incorrectly spelled 3.0.0 version.

That being said, I believe we should go ahead and merge this in now so we don't propagate the miss-spelled property further.

@zvr @kestewart - agree?

@bact
Copy link
Collaborator Author

bact commented Jul 31, 2024

This could be a breaking change if anyone is using the incorrectly spelled 3.0.0 version.

That being said, I believe we should go ahead and merge this in now so we don't propagate the miss-spelled property further.

For anyone using 3.0.0, it will still be the same name with typo, as this PR will apply only to 3.0.1 (and we have separate IRIs for the two). Unless we like to retrospectively change this in 3.0.0 as well.

I think if it is a human author, they may spot the typo and corrected it by themselves (so lesser degree of an issue?). But if it's a machine or machine-assisted, very likely that it will just follow the mis-spelled information in the schema file (which is considered correct).

The Dots tool, for example, is unfortunately affected by this typo:

Screenshot 2024-07-31 at 20 08 10

@bact bact changed the title hasAddedFile: Fix typo: "is is" -> "is" Fix typos: hasPrerequsite -> hasPrerequisite, and others Aug 5, 2024
@bact
Copy link
Collaborator Author

bact commented Aug 6, 2024

For "hasPrerequsite" -> "hasPrerequisite",
if needed, we can also put an errata like one in 2.3.1:

Cardinality 0..1
NOTE: The cardinality was incorrectly printed as 0..* in the original publishing of the 2.3 specification

@zvr zvr merged commit eef2fd0 into spdx:main Aug 6, 2024
1 check passed
@bact bact deleted the fix-typo-hasAddedFile branch August 6, 2024 12:07
@bact bact added the typo Typos, minor spelling errors, or minor incorrect word usage label Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
typo Typos, minor spelling errors, or minor incorrect word usage
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants