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

Fix Vale check #179

Open
clatapie opened this issue Nov 21, 2023 · 0 comments
Open

Fix Vale check #179

clatapie opened this issue Nov 21, 2023 · 0 comments

Comments

@clatapie
Copy link
Collaborator

The Documentation Style Check needed to be disabled (#178).

Vale is failing as visible here .

Here is one of the errors raised by the Vale check:

{"message": "[Vale.Terms] Use 'MAPDL' instead of 'mapdl'.", 
"location": {"path": "doc/source/technology_showcase_examples/techdemo-25/ex_25-tecstent.rst",
"range": {"start": {"line": 27, "column": 34}}},
"severity": "ERROR"}

The previous error refers to the following sentence:

This example is inspired from the model and analysis defined in Chapter 25 of the `Mechanical
APDL Technology Showcase Manual <mapdl_tech_show_>`_.

This error should not be raised as the .vale.ini file is configured with the following TokenIgnores:

TokenIgnores = (:(func|class|meth|attr|py):`(?:.|\n)*?`)|(<.*>)|(.. (code|jupyter-execute)::.*\n|    .*)

This issue in the Vale repository seems to be related to this error.

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

No branches or pull requests

1 participant