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

[CI] Disable cSpell inside code blocks for mermaid, and others? #3747

Closed
Tracked by #2448
chalin opened this issue Jan 9, 2024 · 1 comment · Fixed by #3748
Closed
Tracked by #2448

[CI] Disable cSpell inside code blocks for mermaid, and others? #3747

chalin opened this issue Jan 9, 2024 · 1 comment · Fixed by #3748
Assignees
Labels
CI/infra CI & infrastructure e0-minutes Effort: < 60 min p2-medium

Comments

@chalin
Copy link
Contributor

chalin commented Jan 9, 2024

This was inspired by work on #3651. There are too many false positives in running cSpell over mermaid code blocks, but I'm starting to think that we might want to disable spelling checks for all code blocks. WDYT @open-telemetry/docs-maintainers?

@theletterf
Copy link
Member

Wholeheartedly agree on disabling spell checks for code blocks. The only risk I see is getting typos in code comments, but I'm not that concerned about it if the net outcome is lowering friction for contributors.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/infra CI & infrastructure e0-minutes Effort: < 60 min p2-medium
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants