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

Updates for unit testing docs #6345

Draft
wants to merge 5 commits into
base: current
Choose a base branch
from
+33 −0

Suggested updates from Ganz

8488b99
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Draft

Updates for unit testing docs #6345

Suggested updates from Ganz
8488b99
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Oct 23, 2024 in 0s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (2)

website/docs/docs/build/unit-tests.md|325 col 5| [custom.SentenceCaseHeaders] 'Common Pitfalls' should use sentence-style capitalization. Try '' instead.
website/docs/docs/build/unit-tests.md|329 col 5| [custom.SentenceCaseHeaders] 'How Unit Tests Compile' should use sentence-style capitalization. Try '' instead.

Filtered Findings (3)

website/docs/docs/build/unit-tests.md|13 col 50| [custom.Typos] Oops there's a typo -- did you really mean 'v1.8+'?
website/docs/docs/build/unit-tests.md|19 col 15| [custom.Typos] Oops there's a typo -- did you really mean 'v1.8'?
website/docs/docs/build/unit-tests.md|102 col 167| [custom.LatinAbbreviations] Avoid Latin abbreviations: 'for example'. Consider using 'edge' instead.

Annotations

Check warning on line 325 in website/docs/docs/build/unit-tests.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] website/docs/docs/build/unit-tests.md#L325 

[custom.SentenceCaseHeaders] 'Common Pitfalls' should use sentence-style capitalization. Try '' instead.
Raw output 
{"message": "[custom.SentenceCaseHeaders] 'Common Pitfalls' should use sentence-style capitalization. Try '' instead.", "location": {"path": "website/docs/docs/build/unit-tests.md", "range": {"start": {"line": 325, "column": 5}}}, "severity": "WARNING"}

Check warning on line 329 in website/docs/docs/build/unit-tests.md

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] website/docs/docs/build/unit-tests.md#L329 

[custom.SentenceCaseHeaders] 'How Unit Tests Compile' should use sentence-style capitalization. Try '' instead.
Raw output 
{"message": "[custom.SentenceCaseHeaders] 'How Unit Tests Compile' should use sentence-style capitalization. Try '' instead.", "location": {"path": "website/docs/docs/build/unit-tests.md", "range": {"start": {"line": 329, "column": 5}}}, "severity": "WARNING"}
View more details on GitHub Actions