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

Add missing anchors B.6.4, B.15.3; Swap HTTP cases #2537

Merged
merged 6 commits into from
Aug 13, 2024
Merged

Conversation

bact
Copy link
Contributor

@bact bact commented Aug 7, 2024

  • Remove "Annex" in the title, re-run heading numbering
    • See comments starting from here
  • Add missing anchors B.6.4 and B.15.3 (now 5.4 and 14.3, after re-numbering)
  • Put B.15.2 (14.2) anchor to the right heading
  • Make link to SPDX License List
  • Add internal links to guidelines
  • Put some special characters example inside `...` to differentiate
  • HTTP cases in B.14.1 and B.14.2 (13.1 and 13.2)

- Also make link to SPDX License List
- Put some special characters example inside `...` to differentiate

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact changed the title Add missing anchor B.6.4, B.15.3 Add missing anchors B.6.4, B.15.3; Swap HTTP cases Aug 7, 2024
Use "repository" as everywhere else.

Signed-off-by: Arthit Suriyawongkul <[email protected]>
Copy link
Member

@zvr zvr left a comment

Choose a reason for hiding this comment

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

Since you are making changes, you might as well remove all the numbering; this is not an "Annex" here

@zvr zvr requested a review from jlovejoy August 7, 2024 21:07
@bact
Copy link
Contributor Author

bact commented Aug 7, 2024

Since you are making changes, you might as well remove all the numbering; this is not an "Annex" here

Please explain more please.

Do you mean to remove all the existing heading numbering?

Also in the last line, EXAMPLE: -> For example:, to match the wording used by other guideline sections.

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Copy link
Contributor Author

bact commented Aug 7, 2024

@zvr just to make sure before making changes, do you mean to

  • Remove the "Annex" word from the title
  • Convert existing heading numbering from "B.1, B.2, B.2.1, B.2.2" to "1, 2, 2.1, 2.2" ?

Thank you

@zvr
Copy link
Member

zvr commented Aug 7, 2024

Yes, the whole text can be simplified to something like:


# SPDX license list matching guidelines

The SPDX License List Matching Guidelines provide guidelines ...

## How these guidelines are applied

### Purpose

To ensure consistent results ...

### Guideline: official license headers

The matching guidelines apply to license and exception text, ...

bact added 3 commits August 8, 2024 00:20
Also remove "B" numbering

Signed-off-by: Arthit Suriyawongkul <[email protected]>
Use "guideline(s)" label for internal link within the doc

Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@jlovejoy jlovejoy added this to the 3.25.0 milestone Aug 8, 2024
@jlovejoy
Copy link
Member

jlovejoy commented Aug 8, 2024

Thanks for this @bact and @zvr !

(good catch on updating the numbering - now we are back to the numbering we had had for years prior :)

I just had one question on HTTP v. http caps changes

@bact
Copy link
Contributor Author

bact commented Aug 8, 2024

@jlovejoy on HTTP, please see this comment #2537 (comment)

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.

LGTM, thanks @bact and all!

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.

5 participants