From 03c9db303c628582911227fd81e64dc1462107de Mon Sep 17 00:00:00 2001 From: German <28149841+germa89@users.noreply.github.com> Date: Fri, 3 Nov 2023 20:53:33 +0100 Subject: [PATCH] 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 --- .github/workflows/ci.yml | 1 + doc/.vale.ini | 3 ++- doc/source/api/unit_testing.rst | 2 +- doc/source/examples/devportal.rst | 8 ++++---- .../extended_examples/executable/executable.rst | 2 +- doc/source/getting_started/contribution.rst | 2 +- doc/source/getting_started/learning.rst | 10 +++++----- doc/source/user_guide/index.rst | 14 +++++++------- doc/source/user_guide/krylov.rst | 4 ++-- doc/source/user_guide/mesh_geometry.rst | 3 ++- doc/styles/Vocab/ANSYS/accept.txt | 10 ++++++++-- 11 files changed, 34 insertions(+), 25 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2baf83e58e..0986a3c11d 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -66,6 +66,7 @@ jobs: uses: ansys/actions/doc-style@v4 with: token: ${{ secrets.GITHUB_TOKEN }} + version: 2.29.6 smoke-tests: name: "Build and smoke tests" diff --git a/doc/.vale.ini b/doc/.vale.ini index 7d2d583897..2e76c41081 100644 --- a/doc/.vale.ini +++ b/doc/.vale.ini @@ -27,7 +27,8 @@ Vocab = ANSYS # Apply the following styles BasedOnStyles = Vale, Google -TokenIgnores = (:(func|class|meth|attr|py):`(?:.|\n)*?`)|(<.*>)|(.. code::.*\n| .*) +TokenIgnores = (:(func|class|meth|attr|py):`(?:.|\n)*?`)|(<.*>) # Removing Google-specific rule - Not applicable under some circumstances Google.Colons = NO +Google.Headings = NO \ No newline at end of file diff --git a/doc/source/api/unit_testing.rst b/doc/source/api/unit_testing.rst index ce8f6817e4..74ac56865b 100644 --- a/doc/source/api/unit_testing.rst +++ b/doc/source/api/unit_testing.rst @@ -119,7 +119,7 @@ Most PyMAPDL tests require a connection to a running instance of MAPDL, which makes them integration tests. If your test requires a running MAPDL instance, you can use the PyMAPDL `mapdl `_ method in your function signature. -It will be executed upstream of each test and not within all tests. +It is executed upstream of each test and not within all tests. .. code:: python diff --git a/doc/source/examples/devportal.rst b/doc/source/examples/devportal.rst index aa38ed2a96..7176e618eb 100644 --- a/doc/source/examples/devportal.rst +++ b/doc/source/examples/devportal.rst @@ -5,12 +5,12 @@ PyMAPDL Developer Portal articles ================================= In this section, you'll find informative and insightful blog -articles crafted by our expert developers at Ansys and published +articles crafted by the expert developers at Ansys and published in the `Developer Portal `_. -Whether you're a seasoned pro or just getting started with PYMAPDL, our blog +Whether you're a seasoned pro or just getting started with PyMAPDL, the blog articles cover a wide range of topics, from best practices and tips to in-depth -tutorials and real-world use cases. Our aim is to provide you with a valuable -resource that will help you harness the full potential of PYMAPDL for your +tutorials and real-world use cases. The aim is to provide you with a valuable +resource that can help you harness the full potential of PyMAPDL for your engineering and simulation needs. Because the Developer Portal is your hub for all things related to Ansys diff --git a/doc/source/examples/extended_examples/executable/executable.rst b/doc/source/examples/extended_examples/executable/executable.rst index b68b19b501..6f2b41dc4a 100644 --- a/doc/source/examples/extended_examples/executable/executable.rst +++ b/doc/source/examples/extended_examples/executable/executable.rst @@ -227,7 +227,7 @@ using this approach (non-tested): run: | python rotor.py 4 --density 7000 - - name: "Postprocess images" + - name: "Postprocessing images" run: | COMPOSITE=/usr/bin/composite mogrify -mattecolor #f1ce80 -frame 10x10 volume.jpg diff --git a/doc/source/getting_started/contribution.rst b/doc/source/getting_started/contribution.rst index 922d822911..5be0ac5c19 100644 --- a/doc/source/getting_started/contribution.rst +++ b/doc/source/getting_started/contribution.rst @@ -38,7 +38,7 @@ use these issue templates: * **🎓 Adding an example**: Proposing a new example for the library * **💡 New feature**: Enhancements to the code -If your issue does not fit into one of these categories, click on `Open a blank issue `_. +If your issue does not fit into one of these categories, click in `Open a blank issue `_. Viewing PyMAPDL documentation diff --git a/doc/source/getting_started/learning.rst b/doc/source/getting_started/learning.rst index a57a5e65ed..b421f92dbd 100644 --- a/doc/source/getting_started/learning.rst +++ b/doc/source/getting_started/learning.rst @@ -58,10 +58,10 @@ Course content -Getting Started with PyMAPDL +Getting started with PyMAPDL ---------------------------- -The `Getting Started with PyMAPDL `_ course teaches +The `Getting started with PyMAPDL `_ course teaches you about PyMAPDL, the Pythonic way to access Ansys MAPDL. Course content @@ -76,10 +76,10 @@ Course content -Intro to Ansys Mechanical APDL Scripting +Intro to Ansys Mechanical APDL scripting ---------------------------------------- -The `Intro to Ansys Mechanical APDL Scripting `_ +The `Intro to Ansys Mechanical APDL scripting `_ course teaches you how APDL, the Mechanical solver syntax language, works. Course content @@ -175,4 +175,4 @@ Recommended articles Feel free to share any educational or learning resources by `opening an issue `_ -or `starting a discussion `_ on Github. \ No newline at end of file +or `starting a discussion `_ on GitHub. \ No newline at end of file diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 330af6785b..e94fbbc485 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -79,16 +79,16 @@ example, if you input an invalid command: >>> mapdl.run("AL, 1, 2, 3") - apdlRuntimeError: - L, 1, 2, 3 + MapdlRuntimeError: + AL, 1, 2, 3 - EFINE AREA BY LIST OF LINES - INE LIST = 1 2 3 + DEFINE AREA BY LIST OF LINES + LINE LIST = 1 2 3 TRAVERSED IN SAME DIRECTION AS LINE 1) - ** ERROR *** CP = 0.338 TIME= 09:45:36 - eypoint 1 is referenced by only one line. Improperly connected line - et for AL command. + *** ERROR *** CP = 0.338 TIME= 09:45:36 + Keypoint 1 is referenced by only one line. Improperly connected line + set for AL command. This ``MapdlRuntimeError`` was caught immediately. This means that you can write your MAPDL scripts in Python, run them interactively, and diff --git a/doc/source/user_guide/krylov.rst b/doc/source/user_guide/krylov.rst index 4788b87884..61604bdd21 100644 --- a/doc/source/user_guide/krylov.rst +++ b/doc/source/user_guide/krylov.rst @@ -93,8 +93,8 @@ using Mechanical APDL: >>> mapdl = launch_mapdl() >>> mapdl.prep7() - # Generate the FEA model (mesh, constraints, loads) - # ... + # Generate the FEA model (mesh, constraints, loads) + # ... >>> mapdl.run("/SOLU") >>> mapdl.antype("HARMIC") # HARMONIC ANALYSIS diff --git a/doc/source/user_guide/mesh_geometry.rst b/doc/source/user_guide/mesh_geometry.rst index 6f62aa7ae1..9e1fbd9860 100644 --- a/doc/source/user_guide/mesh_geometry.rst +++ b/doc/source/user_guide/mesh_geometry.rst @@ -235,7 +235,8 @@ One of the most important is that you no longer need to call the entities like y Y Bounds: 0.000e+00, 1.974e+00 Z Bounds: 5.500e-01, 5.500e-01 N Arrays: 4, - ... + ... + **New API** diff --git a/doc/styles/Vocab/ANSYS/accept.txt b/doc/styles/Vocab/ANSYS/accept.txt index 5c3da5e154..de0ee6a543 100644 --- a/doc/styles/Vocab/ANSYS/accept.txt +++ b/doc/styles/Vocab/ANSYS/accept.txt @@ -16,7 +16,9 @@ [Pp]ythonically [Ss]uperelements [Vv]on Mises +2D 3-D +3D aadd aas AAS @@ -25,6 +27,7 @@ ALIS AMLs ans ANSYS +Ansys Mechanical APDL APDL Math APDLMath APIs @@ -60,8 +63,9 @@ extrem filname Fortran FSW -Getting Started with PyMAPDL +GitHub Gmsh +GPa GUI hexahedral hostname @@ -69,7 +73,6 @@ Imagemagick ImageMagick imagin importlib -Intro to Ansys Mechanical APDL Scripting ist Julia Krylov @@ -80,6 +83,7 @@ LDHI levl Linux MacOS +mapdl MAPDL mater MATLAB @@ -89,6 +93,7 @@ midside Mises mkdir MSc +Multi-[Ff]ield multipoint nce Newton-Raphson @@ -140,6 +145,7 @@ trian UCnvrg uncompress unconverged +unpause UNSYM unsymmetric UPF