Add section on comparing SWHID and qualifier canonical order #29
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zacchiro
previously requested changes
Sep 16, 2023
Chapters/6_Qualified_identifiers.md
Outdated
|
|
||
| ### 6.3 Recommendations | ||
| One can determine whether two software artifacts are identical (bit by bit) by | ||
| comparing their core SWHIDs, ignoring all qualifiers. If the core SWHIDs match, |
There was a problem hiding this comment.
Minor: "match" is not defined here and people might wonder what it means.
I propose: "match" → "are equal"
("equal" instead of "identical" just to avoid the repetition with the sentence that follows)
Chapters/6_Qualified_identifiers.md
Outdated
| - They both have the same set of qualifiers. | ||
| - The values of these qualifiers are identical. For instance, if both SWHIDs | ||
| have an `anchor` qualifier, the core SWHID values of these qualifiers should | ||
| match. Similarly, if both have a `lines` qualifier, their values should be the |
There was a problem hiding this comment.
Minor as above + the fact "should" here is incorrect: "value of these qualifiers should match" -> "values of these qualifier are identical".
Chapters/6_Qualified_identifiers.md
Outdated
| - The values of these qualifiers are identical. For instance, if both SWHIDs | ||
| have an `anchor` qualifier, the core SWHID values of these qualifiers should | ||
| match. Similarly, if both have a `lines` qualifier, their values should be the | ||
| same. |
There was a problem hiding this comment.
"their values should be the same" -> "their values are identical"
zacchiro
approved these changes
Sep 16, 2023
zvr
approved these changes
Sep 19, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add section on SWHID comparison, highlight recommended canonical order of qualifiers, implementing consensus on #6.