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

doc: getting started layout #830

Draft
wants to merge 13 commits into
base: main
Choose a base branch
from

[pre-commit.ci] auto fixes from pre-commit.com hooks

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

doc: getting started layout #830

[pre-commit.ci] auto fixes from pre-commit.com hooks
cb3bdd2
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale failed Jan 23, 2025 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (4)

doc/source/getting-started/prerequisites.rst|15 col 1| [Google.Headings] 'Download and install Python' should use sentence-style capitalization.
doc/source/getting-started/prerequisites.rst|21 col 1| [Google.Headings] 'Suported Python versions' should use sentence-style capitalization.
doc/source/getting-started/prerequisites.rst|21 col 1| [Vale.Spelling] Did you really mean 'Suported'?
doc/source/getting-started/prerequisites.rst|48 col 32| [Google.Will] Avoid using 'will'.

Filtered Findings (0)

Annotations

Check warning on line 15 in doc/source/getting-started/prerequisites.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/getting-started/prerequisites.rst#L15 

[Google.Headings] 'Download and install Python' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Download and install Python' should use sentence-style capitalization.", "location": {"path": "doc/source/getting-started/prerequisites.rst", "range": {"start": {"line": 15, "column": 1}}}, "severity": "WARNING"}

Check warning on line 21 in doc/source/getting-started/prerequisites.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/getting-started/prerequisites.rst#L21 

[Google.Headings] 'Suported Python versions' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Suported Python versions' should use sentence-style capitalization.", "location": {"path": "doc/source/getting-started/prerequisites.rst", "range": {"start": {"line": 21, "column": 1}}}, "severity": "WARNING"}

Check failure on line 21 in doc/source/getting-started/prerequisites.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/getting-started/prerequisites.rst#L21 

[Vale.Spelling] Did you really mean 'Suported'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Suported'?", "location": {"path": "doc/source/getting-started/prerequisites.rst", "range": {"start": {"line": 21, "column": 1}}}, "severity": "ERROR"}

Check warning on line 48 in doc/source/getting-started/prerequisites.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/getting-started/prerequisites.rst#L48 

[Google.Will] Avoid using 'will'.
Raw output 
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/getting-started/prerequisites.rst", "range": {"start": {"line": 48, "column": 32}}}, "severity": "WARNING"}
View more details on GitHub Actions