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.

Sign up for GitHub

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

Jump to bottom

In markdown, we should ignore content in the code blocks #6

Closed
macpijan opened this issue Jun 19, 2024 · 4 comments · Fixed by #14
Closed

In markdown, we should ignore content in the code blocks #6

macpijan opened this issue Jun 19, 2024 · 4 comments · Fixed by #14
Assignees
@PLangowski

Comments

@macpijan
Copy link
Member

Code blocks typically contain commands to type, or some logs.
In most cases, we should not alter this content at all.
It triggers a lot of false-positives in dasharo/docs, that is why should be handled first before can be used in production.
m-iwanicki added a commit to zarhus/docs that referenced this issue Sep 11, 2024
@m-iwanicki
pre-commit: remove namespell due to 3mdeb/hooks#6
7750d80 
Signed-off-by: Michał Iwanicki <[email protected]>
@PLangowski PLangowski linked a pull request Sep 13, 2024 that will close this issue
namespell: Ignore text inside code blocks #14
Merged
@PLangowski
Copy link
Contributor

@macpijan Let me know if #14 resolves this.

@PLangowski PLangowski reopened this Oct 22, 2024
@macpijan
Copy link
Member Author

Have you tried running it against dasharo/docs repo? That should give us an answer if we include such a result here.

@PLangowski
Copy link
Contributor

PLangowski commented Oct 24, 2024 •
edited
Loading

The results are as follows:


docs/variants/pc_engines/openness_score.md:69: 'COREBOOT' should be 'coreboot'
docs/variants/novacustom_nv4x_tgl/compatibility-check-results-ubuntu.md:132: 'dasharo' should be 'Dashar
docs/unified/protectli/initial-deployment.md:94: 'COREBOOT' should be 'coreboot'
docs/variants/protectli_vp2410/openness-score.md:58: 'COREBOOT' should be 'coreboot'
docs/variants/pc_engines/faq.md:14: 'Coreboot' should be 'coreboot'
docs/guides/dasharo-reviewers-guide.md:56: 'Uefi' should be 'UEFI'
docs/variants/novacustom_nv4x_tgl/openness-score.md:97: 'COREBOOT' should be 'coreboot'
docs/variants/supermicro_x11_lga1151_series/overview.md:53: 'CoreBoot' should be 'coreboot'
docs/variants/protectli_v1000-series/openness-score.md:62: 'COREBOOT' should be 'coreboot'
docs/variants/versions.md:11: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:12: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:13: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:14: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:15: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:15: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:16: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:16: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:22: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:22: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:23: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:23: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:27: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:27: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:29: 'dasharo' should be 'Dasharo'
docs/variants/versions.md:29: 'dasharo' should be 'Dasharo'
docs/unified-test-documentation/dasharo-compatibility/319-nvidia-graphics.md:86: 'Nvidia' should be 'NVIDIA'
docs/variants/protectli_vp2420/openness-score.md:97: 'COREBOOT' should be 'coreboot'
docs/unified/msi/hcl.md:239: 'Nvidia' should be 'NVIDIA'
docs/unified/msi/hcl.md:241: 'NVidia' should be 'NVIDIA'
docs/unified/msi/hcl.md:242: 'NVidia' should be 'NVIDIA'
docs/unified/msi/hcl.md:243: 'Nvidia' should be 'NVIDIA'
docs/variants/msi_z790/openness_score.md:40: 'COREBOOT' should be 'coreboot'
docs/variants/msi_z790/openness_score.md:203: 'COREBOOT' should be 'coreboot'
docs/unified/clevo/post-install.md:60: 'Nvidia' should be 'NVIDIA'
docs/unified/clevo/post-install.md:62: 'Nvidia' should be 'NVIDIA'
docs/unified/clevo/post-install.md:65: 'Nvidia' should be 'NVIDIA'
docs/unified/msi/recovery.md:57: 'dasharo' should be 'Dasharo'
docs/variants/msi_z790/releases.md:151: 'Nvidia' should be 'NVIDIA'
docs/variants/msi_z690/openness_analysis.md:29: 'COREBOOT' should be 'coreboot'
docs/variants/msi_z690/openness_analysis.md:34: 'COREBOOT' should be 'coreboot'
docs/variants/msi_z690/openness_analysis.md:70: 'COREBOOT' should be 'coreboot'
docs/variants/msi_z690/openness_analysis.md:106: 'COREBOOT' should be 'coreboot'
docs/variants/novacustom_nv4x_adl/openness-score.md:98: 'COREBOOT' should be 'coreboot'
docs/variants/novacustom_ns5x_adl/openness-score.md:98: 'COREBOOT' should be 'coreboot'
docs/variants/msi_z690/openness_score.md:43: 'COREBOOT' should be 'coreboot'
docs/variants/msi_z690/openness_score.md:206: 'COREBOOT' should be 'coreboot'
docs/variants/novacustom_ns5x_tgl/openness-score.md:97: 'COREBOOT' should be 'coreboot'
docs/variants/dell_optiplex/openness-score.md:35: 'COREBOOT' should be 'coreboot'
docs/variants/asus_kgpe_d16/tpm-mboot.md:34: 'COREBOOT' should be 'coreboot'
docs/variants/novacustom_v560tu/openness-score.md:129: 'COREBOOT' should be 'coreboot'
docs/variants/novacustom_v540tu/openness-score.md:129: 'COREBOOT' should be 'coreboot'
docs/variants/protectli_vp66xx/openness_score.md:97: 'COREBOOT' should be 'coreboot'
docs/variants/protectli_vp46xx/openness_score.md:99: 'COREBOOT' should be 'coreboot'
docs/ways-you-can-help-us.md:68: 'dasharo' should be 'Dasharo'
docs/variants/msi_z690/releases.md:146: 'Nvidia' should be 'NVIDIA'
docs/variants/novacustom_nv4x_tgl/releases.md:518: 'Nvidia' should be 'NVIDIA'
docs/variants/novacustom_nv4x_tgl/releases.md:547: 'nvidia' should be 'NVIDIA'
docs/variants/novacustom_nv4x_tgl/releases.md:563: 'Nvidia' should be 'NVIDIA'
docs/variants/novacustom_nv4x_tgl/releases.md:666: 'Coreboot' should be 'coreboot'

A lot of these errors are standard - many files in the repo have that spelling intentionally; Those occurences should be ignored using comments.
However, I noticed one thing, which should probably be worked on: the tool doesn't ignore URLs and links to document sections.

@macpijan
Copy link
Member Author

macpijan commented Oct 24, 2024 •
edited
Loading

Thanks. So the goal of ignoring code blocks looks resolved. We have detected another issue, regarding links (although maybe these can also be ignored via comments).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@PLangowski PLangowski

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

namespell: Ignore text inside code blocks 3mdeb/hooks
2 participants
@macpijan @PLangowski