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

Update license-matching-guidelines-and-templates.md #2469

Merged
merged 3 commits into from
May 15, 2024

Conversation

jlovejoy
Copy link
Member

@jlovejoy jlovejoy commented May 9, 2024

fixes #1617

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

Also updated punctuation guideline to note that exceptions (e.g., Oxford comma or not) may have markup.

fixes #1617 

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

Also updated punctuation guideline to note that exceptions (e.g., Oxford comma or not) may have markup.
@jlovejoy jlovejoy added this to the 3.24 milestone May 9, 2024
@jlovejoy jlovejoy self-assigned this May 9, 2024
@jlovejoy jlovejoy requested a review from swinslow May 9, 2024 18:36
@jlovejoy
Copy link
Member Author

jlovejoy commented May 9, 2024

heads up @goneall - I did NOT put this in the punctuation guideline, since this is not punctuation, but is more like code comments (in my view) as these are similarly characters that are not there for the text, but more for formatting. I was trying not to make an entirely new guideline, since it doesn't seem to warrant that.

@goneall
Copy link
Member

goneall commented May 9, 2024

heads up @goneall - I did put this in the punctuation guideline, since this is not punctuation, but is more like code comments (in my view) as these are similarly characters that are not there for the text, but more for formatting. I was trying not to make an entirely new guideline, since it doesn't seem to warrant that.

Thanks for the heads-up - the changes look good to me and are already implemented in the Java and online tools

@jlovejoy
Copy link
Member Author

@swinslow - you want to review and merge?


### 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, e.g., ---, ===, ___, or ***.
Copy link
Member

Choose a reason for hiding this comment

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

Super-minor nit, looks like there's a stray extra space introduced by accident between "to" and "the"

Copy link
Member

@swinslow swinslow left a comment

Choose a reason for hiding this comment

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

@jlovejoy Looks good to me! There's one super-minor nit I noticed, which I'll fix in a follow-up commit momentarily -- will merge after that.

Signed-off-by: Steve Winslow <steve@swinslow.net>
@swinslow swinslow merged commit 5ce7cd6 into main May 15, 2024
5 checks passed
@swinslow swinslow deleted the jlovejoy-matching-guidelines branch May 15, 2024 03:05
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.

Matching guidelines: ignore length or number of underscores
3 participants