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

Postulate that snippet tags be closed #95

Merged
merged 4 commits into from
Oct 17, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Postulate that snippet tags be closed
Signed-off-by: Carmen Bianca BAKKER <carmenbianca@fsfe.org>
  • Loading branch information
carmenbianca committed Sep 26, 2024
commit 8327670a6279a578dfc61f4481c7f2f8a2789f54
4 changes: 3 additions & 1 deletion site/content/en/spec-3.3.md
Original file line number Diff line number Diff line change
@@ -177,12 +177,14 @@ An example of a comment header:
#### In-line Snippet comments

Sometimes Licensing Information only applies to a certain Snippet instead of the
whole Commentable File. For these cases SPDX snippet tags MUST be used for that
whole Commentable File. For these cases, SPDX snippet tags MUST be used for that
Snippet (as defined in [SPDX Specification, Annex
Copy link
Member Author

Choose a reason for hiding this comment

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

Eh, even when corrected, this language is awkward. Let's reword.

Copy link
Member Author

Choose a reason for hiding this comment

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

Disambiguate: make SPDX snippets optional

H](https://spdx.github.io/spdx-spec/v2.3/file-tags/#h3-snippet-tags-format)).
This means that Copyright Notices inside of Snippets MUST be prefixed with
`SPDX-SnippetCopyrightText`.

Each Snippet that is opened MUST be closed with `SPDX-SnippetEnd`.

Like with comment headers, the SPDX snippet tags SHOULD be commented.

A Snippet SHOULD contain both a Copyright Notice and an SPDX License Expression.