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

Google.Headers producing false positives #799

Open
1 task done
dipinknair opened this issue Mar 27, 2024 · 5 comments
Open
1 task done

Google.Headers producing false positives #799

dipinknair opened this issue Mar 27, 2024 · 5 comments

Comments

@dipinknair
Copy link

Check for existing issues

  • Completed

Environment

Windows. Vale version 3.1.0 , choco install

Describe the bug / provide steps to reproduce it

Google heading giving warning even though sentence-style capitalization is used.

 doc\source\coding-style\deprecation.rst
 1:1  warning  'Deprecation best practices'    Google.Headings
               should use sentence-style
               capitalization.

this is my vale config file

# Core settings
# =============

# Location of our `styles`
StylesPath = "styles"

# The options are `suggestion`, `warning`, or `error` (defaults to “warning”).
MinAlertLevel = warning

# By default, `code` and `tt` are ignored.
IgnoredScopes = code, tt

# By default, `script`, `style`, `pre`, and `figure` are ignored.
SkippedScopes = script, style, pre, figure

# WordTemplate specifies what Vale will consider to be an individual word.
WordTemplate = \b(?:%s)\b

# List of Packages to be used for our guidelines
Packages = Google

# Define the Ansys vocabulary
Vocab = ANSYS

[*.{rst}]

# Apply the following styles
BasedOnStyles = Vale, Google
Vale.Terms = NO

# Inline roles are ignored
TokenIgnores = (:.*:`.*`)

# Removing Google-specific rule - Not applicable under some circumstances
Google.WordList = NO
Google.Colons = NO

I am not seeing any issues in other repos where 3.1.0 is used.

to repoduce : clone this repo
from repo folder vale --config=doc/.vale.ini sync and vale --config=doc/.vale.ini doc

@jdkato
Copy link
Member

jdkato commented Mar 27, 2024

There a few things I don't understand:

  • The provided repo is using the pre-3.0 configuration layout, so are you sure you're using v3.1.0?
  • Even if that is resolved, I can't reproduce the issue.

I would suggest updated to the latest version.

@dipinknair
Copy link
Author

@jdkato this is PR with updated vale version
https://github.com/ansys/pyansys-dev-guide/actions/runs/8421812759/job/23059594919?pr=426https://github.com/ansys/pyansys-dev-guide/actions/runs/8421812759/job/23059594919?pr=426

  reviewdog: found at least one result in diff
Error: reviewdog exited with status code: 1

Because of this I am testing locally since it does not say anything much.

@jdkato
Copy link
Member

jdkato commented Apr 4, 2024

Those results look accurate to me? Terms like "Flake8", "CSV", "README", etc., need to be added to a vocabulary when you intend to use them in violation of a case style.

@dipinknair
Copy link
Author

But they are just warnings right? Will those warnings creates issue . How ever I will try with fixing them.

@dipinknair
Copy link
Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants