From ab08b143807995a299e2677bee69289867f4c897 Mon Sep 17 00:00:00 2001 From: German Date: Mon, 9 Oct 2023 12:23:44 +0200 Subject: [PATCH 1/3] fixing reference --- doc/source/user_guide/pool.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/user_guide/pool.rst b/doc/source/user_guide/pool.rst index 22af3fc372..9e2d8a927e 100644 --- a/doc/source/user_guide/pool.rst +++ b/doc/source/user_guide/pool.rst @@ -2,8 +2,8 @@ Create a pool of MAPDL instances ================================ -PyMAPDL contains the :class:`LocalMapdlPool -` class to simplify creating multiple +PyMAPDL contains the :class:`LocalMapdlPool ` +class to simplify creating multiple local instances of the :class:`Mapdl ` class for batch processing. This can be used for the batch processing of a set of input files, convergence analysis, or other batch related From 843a811d44c19fff7659f83bbbb9cbf745cb9739 Mon Sep 17 00:00:00 2001 From: German Date: Mon, 9 Oct 2023 12:24:35 +0200 Subject: [PATCH 2/3] fixing bat file internal links --- doc/make.bat | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/make.bat b/doc/make.bat index bdf99fb5df..588240614e 100644 --- a/doc/make.bat +++ b/doc/make.bat @@ -13,8 +13,8 @@ set LINKCHECKDIR=\%BUILDDIR%\linkcheck if "%1" == "" goto help if "%1" == "clean" goto clean -if "%1" == "clean-all" goto clean-all if "%1" == "clean-examples" goto clean-examples +if "%1" == "clean-except-examples" goto clean-except-examples if "%1" == "linkcheck" goto linkcheck @@ -35,12 +35,14 @@ if errorlevel 9009 ( goto end :clean-except-examples +echo Cleaning everything except examples rmdir /s /q %BUILDDIR% > /NUL 2>&1 rmdir /s /q images/auto-generated > /NUL 2>&1 for /d /r %SOURCEDIR% %%d in (_autosummary) do @if exist "%%d" rmdir /s /q "%%d" goto end :clean +echo Cleaning everything rmdir /s /q %BUILDDIR% > /NUL 2>&1 rmdir /s /q source\examples\gallery_examples > /NUL 2>&1 for /d /r %SOURCEDIR% %%d in (_autosummary) do @if exist "%%d" rmdir /s /q "%%d" @@ -48,6 +50,7 @@ rmdir /s /q images/auto-generated > /NUL 2>&1 goto end :clean-examples +echo Cleaning examples rmdir /s /q source\examples\gallery_examples > /NUL 2>&1 goto end From fa788d0bc37eb8ddc4a0964ec76bb5b294e486b1 Mon Sep 17 00:00:00 2001 From: German Date: Mon, 9 Oct 2023 19:05:09 +0200 Subject: [PATCH 3/3] Fixing vale runtime issue --- doc/source/api/unit_testing.rst | 6 ++++-- doc/source/links.rst | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/source/api/unit_testing.rst b/doc/source/api/unit_testing.rst index aaef4a6815..7b56513f05 100644 --- a/doc/source/api/unit_testing.rst +++ b/doc/source/api/unit_testing.rst @@ -19,7 +19,7 @@ tests several units of the code to ensure that they all work together. To verify that all code is properly tested, you must ensure that every piece of code is used (covered) in at least one unit test. In this repository, the -`Codecov `_ tool generates a coverage report of the +`Codecov `_ tool generates a coverage report of the committed code. It details how merging a pull request would impact coverage. It is one of the checks that must run successfully to merge code changes. @@ -93,6 +93,7 @@ lifecycle, providing a comprehensive CI/CD approach. .. figure:: ../images/cicd.jpg :width: 300pt + Creation of a unit test ----------------------- @@ -106,12 +107,13 @@ For more information, see `pytest usage `_. Here are some guidelines for creating good unit tests: - Assign long and descriptive names to tests. -- Use the `Codecov `_ tool to ensure all implemented code is tested. +- Use the `Codecov `_ tool to ensure all implemented code is tested. - Check that tests return the same results each time. - Verify that tests are independent. - Write tests that verify only one part of the code at a time. - Make tests as short and fast as possible. + `What makes a good unit test `_ is an exhaustive list of tips for creating good unit tests. diff --git a/doc/source/links.rst b/doc/source/links.rst index 5949e5276f..ee73f00f03 100644 --- a/doc/source/links.rst +++ b/doc/source/links.rst @@ -110,7 +110,7 @@ .. _gh_creating_pat: https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token .. _gh_centos_wsl_1: https://github.com/wsldl-pg/CentWSL/ .. _gh_centos_wsl_2: https://github.com/mishamosher/CentOS-WSL/ -.. _codecov: https://github.com/codecov +.. _codecov_ref: https://github.com/codecov .. _WSL_Windows_Toolbar_Launcher: https://github.com/cascadium/wsl-windows-toolbar-launcher .. _disabling_firewall_on_wsl: https://github.com/cascadium/wsl-windows-toolbar-launcher#firewall-rules