-
Notifications
You must be signed in to change notification settings - Fork 120
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
Fixing vale warning #2394
Fixing vale warning #2394
Conversation
Thanks for opening a Pull Request. If you want to perform a review write a comment saying: @ansys-reviewer-bot review |
Codecov Report
@@ Coverage Diff @@
## main #2394 +/- ##
==========================================
- Coverage 87.93% 81.88% -6.05%
==========================================
Files 44 44
Lines 8453 8453
==========================================
- Hits 7433 6922 -511
- Misses 1020 1531 +511 |
I'm not sure why this happens. First time I saw it was in #2384 I suspect it is a bug in vale, because nothing really changed on our side, and they released a new patch version 16h ago: https://github.com/errata-ai/vale/releases/tag/v2.29.2 Pinging @Revathyvenugopal162 @RobPasMue |
@clatapie try adding mapdl and Mapdl in the vale accept.txt file. (may be the conflict between codespell and vale) |
Thinking it more thoughtful, because the latest vale version was failing silently, we might have been having this issue for a long time.
It is already in pymapdl/doc/styles/Vocab/ANSYS/accept.txt Line 83 in e83e4a5
However the problem is that vale is analysis text inside code blocks, references, inline code, etc. |
An identical issue is raised in the PyMAPDL-Examples repository. |
Co-authored-by: Revathy Venugopal <104772255+Revathyvenugopal162@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall I'm happy with this PR. Thank you for taking care of it.
Couple of remarks:
- The file
.vale.ini
has change completely, but actually only couple of lines have changed. I would suggest you to revert back that file to the version in main, and then do in the desired lines the changes you want. I would like to no "alter" the github history in the lines not actually changed. - Changes in the headings/titles in
troubleshoot.rst
. I presume you did it because you want to keep consistency with other documents. I appreciate that. But because of that, we ran out of section headers. I rather change consistency but have headers and reference there. Furthermore, theubuntu
section I reference it a lot in projects and externally.
…to fix/codestyle
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small comment.
Ideally with the regex we are using we wouldn't have to make so many links changes (from two lines to one).
I am happy to keep those changes because it helps VSCode to highlight them in the editor.
Good work!
Hello! 👋 Your PR is changing the image cache. So I am attaching the new image cache This commit does not re-run the CICD workflows (since no changes are made in the codebase) therefore You might want to rerun the test to make sure that everything is passing. You can retrigger the CICD sending an empty commit You will see this message everytime your commit changes the image cache but you are not attaching the updated cache. 🤓 |
Hello! 👋 Your PR is changing the image cache. So I am attaching the new image cache This commit does not re-run the CICD workflows (since no changes are made in the codebase) therefore You might want to rerun the test to make sure that everything is passing. You can retrigger the CICD sending an empty commit You will see this message everytime your commit changes the image cache but you are not attaching the updated cache. 🤓 |
Vale errors have appeared and need to be fixed: