Skip to content

Fix Markdown lint warnings to avoid rendering issue#2

Merged
kestewart merged 4 commits into
spdx:mainfrom
bact:main
Sep 3, 2024
Merged

Fix Markdown lint warnings to avoid rendering issue#2
kestewart merged 4 commits into
spdx:mainfrom
bact:main

Conversation

@bact
Copy link
Copy Markdown
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 <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Copy link
Copy Markdown
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 <arthit@gmail.com>
@bact
Copy link
Copy Markdown
Contributor Author

bact commented Sep 3, 2024

Conflicts sorted

@kestewart
Copy link
Copy Markdown
Collaborator

Thanks for fixing the conflicts Art!

@kestewart kestewart merged commit cbda324 into spdx:main Sep 3, 2024
kestewart pushed a commit that referenced this pull request Oct 14, 2025
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