Skip to content

Commit 03c9db3

Browse files
authored
Fix vale 2.29.6 (#2475)
* Disabling Google heading. Adding `mapdl` (lowercase) to accepts. Fixing other warnings. * fixing vale version to avoid pipeline unexpected breakdowns. * Undoing changes from main
1 parent 0e7f3f4 commit 03c9db3

File tree

11 files changed

+34
-25
lines changed

11 files changed

+34
-25
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ jobs:
6666
uses: ansys/actions/doc-style@v4
6767
with:
6868
token: ${{ secrets.GITHUB_TOKEN }}
69+
version: 2.29.6
6970

7071
smoke-tests:
7172
name: "Build and smoke tests"

doc/.vale.ini

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ Vocab = ANSYS
2727
# Apply the following styles
2828
BasedOnStyles = Vale, Google
2929

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

3232
# Removing Google-specific rule - Not applicable under some circumstances
3333
Google.Colons = NO
34+
Google.Headings = NO

doc/source/api/unit_testing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Most PyMAPDL tests require a connection to a running instance of
119119
MAPDL, which makes them integration tests. If your test
120120
requires a running MAPDL instance, you can use the PyMAPDL
121121
`mapdl <mapdl_fixture_>`_ method in your function signature.
122-
It will be executed upstream of each test and not within all tests.
122+
It is executed upstream of each test and not within all tests.
123123

124124
.. code:: python
125125

doc/source/examples/devportal.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ PyMAPDL Developer Portal articles
55
=================================
66

77
In this section, you'll find informative and insightful blog
8-
articles crafted by our expert developers at Ansys and published
8+
articles crafted by the expert developers at Ansys and published
99
in the `Developer Portal <developer_portal_>`_.
10-
Whether you're a seasoned pro or just getting started with PYMAPDL, our blog
10+
Whether you're a seasoned pro or just getting started with PyMAPDL, the blog
1111
articles cover a wide range of topics, from best practices and tips to in-depth
12-
tutorials and real-world use cases. Our aim is to provide you with a valuable
13-
resource that will help you harness the full potential of PYMAPDL for your
12+
tutorials and real-world use cases. The aim is to provide you with a valuable
13+
resource that can help you harness the full potential of PyMAPDL for your
1414
engineering and simulation needs.
1515

1616
Because the Developer Portal is your hub for all things related to Ansys

doc/source/examples/extended_examples/executable/executable.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ using this approach (non-tested):
227227
run: |
228228
python rotor.py 4 --density 7000
229229
230-
- name: "Postprocess images"
230+
- name: "Postprocessing images"
231231
run: |
232232
COMPOSITE=/usr/bin/composite
233233
mogrify -mattecolor #f1ce80 -frame 10x10 volume.jpg

doc/source/getting_started/contribution.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ use these issue templates:
3838
* **🎓 Adding an example**: Proposing a new example for the library
3939
* **💡 New feature**: Enhancements to the code
4040

41-
If your issue does not fit into one of these categories, click on `Open a blank issue <pymapdl_new_blank_issue_>`_.
41+
If your issue does not fit into one of these categories, click in `Open a blank issue <pymapdl_new_blank_issue_>`_.
4242

4343

4444
Viewing PyMAPDL documentation

doc/source/getting_started/learning.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ Course content
5858

5959

6060

61-
Getting Started with PyMAPDL
61+
Getting started with PyMAPDL
6262
----------------------------
6363

64-
The `Getting Started with PyMAPDL <course_getting_started_pymapdl_>`_ course teaches
64+
The `Getting started with PyMAPDL <course_getting_started_pymapdl_>`_ course teaches
6565
you about PyMAPDL, the Pythonic way to access Ansys MAPDL.
6666

6767
Course content
@@ -76,10 +76,10 @@ Course content
7676

7777

7878

79-
Intro to Ansys Mechanical APDL Scripting
79+
Intro to Ansys Mechanical APDL scripting
8080
----------------------------------------
8181

82-
The `Intro to Ansys Mechanical APDL Scripting <course_intro_apdl_>`_
82+
The `Intro to Ansys Mechanical APDL scripting <course_intro_apdl_>`_
8383
course teaches you how APDL, the Mechanical solver syntax language, works.
8484

8585
Course content
@@ -175,4 +175,4 @@ Recommended articles
175175
176176
177177
Feel free to share any educational or learning resources by `opening an issue <pymapdl_issues_>`_
178-
or `starting a discussion <pymapdl_discussions_>`_ on Github.
178+
or `starting a discussion <pymapdl_discussions_>`_ on GitHub.

doc/source/user_guide/index.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,16 +79,16 @@ example, if you input an invalid command:
7979
8080
>>> mapdl.run("AL, 1, 2, 3")
8181
82-
apdlRuntimeError:
83-
L, 1, 2, 3
82+
MapdlRuntimeError:
83+
AL, 1, 2, 3
8484
85-
EFINE AREA BY LIST OF LINES
86-
INE LIST = 1 2 3
85+
DEFINE AREA BY LIST OF LINES
86+
LINE LIST = 1 2 3
8787
TRAVERSED IN SAME DIRECTION AS LINE 1)
8888
89-
** ERROR *** CP = 0.338 TIME= 09:45:36
90-
eypoint 1 is referenced by only one line. Improperly connected line
91-
et for AL command.
89+
*** ERROR *** CP = 0.338 TIME= 09:45:36
90+
Keypoint 1 is referenced by only one line. Improperly connected line
91+
set for AL command.
9292
9393
This ``MapdlRuntimeError`` was caught immediately. This means that
9494
you can write your MAPDL scripts in Python, run them interactively, and

doc/source/user_guide/krylov.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ using Mechanical APDL:
9393
>>> mapdl = launch_mapdl()
9494
>>> mapdl.prep7()
9595
96-
# Generate the FEA model (mesh, constraints, loads)
97-
# ...
96+
# Generate the FEA model (mesh, constraints, loads)
97+
# ...
9898
9999
>>> mapdl.run("/SOLU")
100100
>>> mapdl.antype("HARMIC") # HARMONIC ANALYSIS

doc/source/user_guide/mesh_geometry.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,8 @@ One of the most important is that you no longer need to call the entities like y
235235
Y Bounds: 0.000e+00, 1.974e+00
236236
Z Bounds: 5.500e-01, 5.500e-01
237237
N Arrays: 4,
238-
...
238+
...
239+
239240
240241
**New API**
241242

0 commit comments

Comments
 (0)