Skip to content

Commit

Permalink
Update license-matching-guidelines-and-templates.md
Browse files Browse the repository at this point in the history
fixes #1617 

Adds guideline for ---, ***, etc.

Also updated punctuation guideline to note that exceptions (e.g., Oxford comma or not) may have markup.
  • Loading branch information
jlovejoy committed May 9, 2024
1 parent f0acb13 commit 300a05f
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions DOCS/license-matching-guidelines-and-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,11 @@ XML files do not require specific markup to implement this guideline.

Because punctuation can change the meaning of a sentence, punctuation needs to be included in the matching process.

XML files do not require specific markup to implement this guideline.
XML files do not require specific markup to implement this guideline, unless to indicate an exception to the guideline.

### B.6.2 Guideline: punctuation <a name="B.6.2"></a>

Punctuation should be matched, unless otherwise stated in these guidelines.
Punctuation should be matched, unless otherwise stated in these guidelines or unless specific markup is added.

### B.6.3 Guideline: hyphens, dashes <a name="B.6.3"></a>

Expand All @@ -103,18 +103,24 @@ Any hyphen, dash, en dash, em dash, or other variation should be considered equi

Any variation of quotations (single, double, curly, etc.) should be considered equivalent.

## B.7 Code Comment Indicators <a name="B.7"></a>
## B.7 Code Comment Indicators or Separators <a name="B.7"></a>

### B.7.1 Purpose <a name="B.7.1"></a>

To avoid the possibility of a non-match due to the existence or absence of code comment indicators placed within the license text, e.g. at the start of each line of text.
To avoid the possibility of a non-match due to the existence or absence of code comment indicators placed within the license text, e.g. at the start of each line of text, or repetitive characters to establish a separation of text.

### B.7.2 Guideline <a name="B.7.2"></a>

Any kind of code comment indicator or prefix which occurs at the beginning of each line in a matchable section should be ignored for matching purposes.

XML files do not require specific markup to implement this guideline.

### B.7.3 Guideline <a name="B.7.3"></a>

A non-letter character repeated 3 or more times to establish a visual separation should be ignored for matching purposes.

XML files do not require specific markup to implement this guideline.

## B.8 Bullets and numbering <a name="B.8"></a>

### B.8.1 Purpose <a name="B.8.1"></a>
Expand Down

0 comments on commit 300a05f

Please sign in to comment.