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: Update known issues and limitations #829

Merged
merged 7 commits into from
Jul 26, 2024

doc review

656786f
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Merged

DOC: Update known issues and limitations #829

doc review
656786f
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Jul 26, 2024 in 0s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (7)

doc/source/kil/index.rst|41 col 82| [Google.We] Try to avoid using first-person plural like 'our'.
doc/source/kil/index.rst|42 col 1| [Google.We] Try to avoid using first-person plural like 'We'.
doc/source/kil/pymechanical.rst|9 col 1| [Google.We] Try to avoid using first-person plural like 'We'.
doc/source/kil/pymechanical.rst|13 col 1| [Google.Headings] 'v0.11.x' should use sentence-style capitalization.
doc/source/kil/mechanical.rst|15 col 1| [Google.Headings] '24R2' should use sentence-style capitalization.
doc/source/kil/mechanical.rst|26 col 1| [Google.Headings] '24R1' should use sentence-style capitalization.
doc/source/user_guide_embedding/configuration.rst|3 col 1| [Google.Headings] 'Addin configuration' should use sentence-style capitalization.

Filtered Findings (0)

Annotations

Check warning on line 41 in doc/source/kil/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/kil/index.rst#L41 

[Google.We] Try to avoid using first-person plural like 'our'.
Raw output 
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "doc/source/kil/index.rst", "range": {"start": {"line": 41, "column": 82}}}, "severity": "WARNING"}

Check warning on line 42 in doc/source/kil/index.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/kil/index.rst#L42 

[Google.We] Try to avoid using first-person plural like 'We'.
Raw output 
{"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "doc/source/kil/index.rst", "range": {"start": {"line": 42, "column": 1}}}, "severity": "WARNING"}

Check warning on line 9 in doc/source/kil/pymechanical.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/kil/pymechanical.rst#L9 

[Google.We] Try to avoid using first-person plural like 'We'.
Raw output 
{"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "doc/source/kil/pymechanical.rst", "range": {"start": {"line": 9, "column": 1}}}, "severity": "WARNING"}

Check warning on line 13 in doc/source/kil/pymechanical.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/kil/pymechanical.rst#L13 

[Google.Headings] 'v0.11.x' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'v0.11.x' should use sentence-style capitalization.", "location": {"path": "doc/source/kil/pymechanical.rst", "range": {"start": {"line": 13, "column": 1}}}, "severity": "WARNING"}

Check warning on line 15 in doc/source/kil/mechanical.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/kil/mechanical.rst#L15 

[Google.Headings] '24R2' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] '24R2' should use sentence-style capitalization.", "location": {"path": "doc/source/kil/mechanical.rst", "range": {"start": {"line": 15, "column": 1}}}, "severity": "WARNING"}

Check warning on line 26 in doc/source/kil/mechanical.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/kil/mechanical.rst#L26 

[Google.Headings] '24R1' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] '24R1' should use sentence-style capitalization.", "location": {"path": "doc/source/kil/mechanical.rst", "range": {"start": {"line": 26, "column": 1}}}, "severity": "WARNING"}

Check warning on line 3 in doc/source/user_guide_embedding/configuration.rst

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] doc/source/user_guide_embedding/configuration.rst#L3 

[Google.Headings] 'Addin configuration' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] 'Addin configuration' should use sentence-style capitalization.", "location": {"path": "doc/source/user_guide_embedding/configuration.rst", "range": {"start": {"line": 3, "column": 1}}}, "severity": "WARNING"}
View more details on GitHub Actions