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

Fix Markdown lint warnings to avoid rendering issue #2

Merged
merged 4 commits into from
Sep 3, 2024

Conversation

bact
Copy link
Contributor

@bact bact commented Jul 11, 2024

Fix Markdown lint warnings to avoid any possible rendering issue due to Markdown-flavour incompatibility:

  • MD022/blanks-around-headings: Headings should be surrounded by blank lines
  • MD031/blanks-around-fences: Fenced code blocks should be surrounded by blank lines
  • MD032/blanks-around-lists: Lists should be surrounded by blank lines
  • MD047/single-trailing-newline: Files should end with a single newline character

For example, one of the known issues is the list display. See: https://spdx.github.io/spdx-spec/v3.0/annexes/using-SPDX-to-comply-with-industry-guidance/

(was spdx/spdx-spec#927 before some docs got moved here)

bact added 3 commits July 11, 2024 01:36
Fix Markdown lint warnings to avoid any possible rendering issue due to Markdown-flavour incompatibility:

- MD022/blanks-around-headings: Headings should be surrounded by blank lines
- MD031/blanks-around-fences: Fenced code blocks should be surrounded by blank lines
- MD032/blanks-around-lists: Lists should be surrounded by blank lines
- MD047/single-trailing-newline: Files should end with a single newline character

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

@kestewart kestewart left a comment

Choose a reason for hiding this comment

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

LGTM.

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

bact commented Sep 3, 2024

Conflicts sorted

@kestewart
Copy link
Collaborator

Thanks for fixing the conflicts Art!

@kestewart kestewart merged commit cbda324 into spdx:main Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants