feat: type hint and docstring length (#340)

Author: clatapie

.github/workflows/ci_cd.yml

@@ -14,13 +14,13 @@ on:
       - main
 
 env:
-  MAIN_PYTHON_VERSION: '3.10'
+  MAIN_PYTHON_VERSION: '3.12'
   PACKAGE_NAME: 'pyconverter-xml2py'
   PACKAGE_NAMESPACE: 'pyconverter.xml2py'
   DOCUMENTATION_CNAME: 'pyconverter-xml2py.docs.pyansys.com'
-  RESET_PIP_CACHE: 2
-  RESET_AUTOSUMMARY_CACHE: 2
-  RESET_DOC_BUILD_CACHE: 2
+  RESET_PIP_CACHE: 10
+  RESET_AUTOSUMMARY_CACHE: 10
+  RESET_DOC_BUILD_CACHE: 10
   ON_CI: true
 
 concurrency:
@@ -48,7 +48,6 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 
-
   smoke-tests:
     name: Build and Smoke tests (Linux)
     runs-on: ubuntu-latest
@@ -229,6 +228,8 @@ jobs:
         with:
             cname: ${{ env.DOCUMENTATION_CNAME }}
             token: ${{ secrets.GITHUB_TOKEN }}
+            bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+            bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
 
 
   release:
@@ -262,4 +263,5 @@ jobs:
         with:
             cname: ${{ env.DOCUMENTATION_CNAME }}
             token: ${{ secrets.GITHUB_TOKEN }}
-            python-version: ${{ env.MAIN_PYTHON_VERSION }}
+            bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+            bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}

doc/source/user_guide/source_code.rst

@@ -146,21 +146,21 @@ into account and added to the Python docstring:
 
                 Parameters
                 ----------
-                nl1 : str
+                nl1: str
                     Number of the first line to be hit (touched by the end of the new line). If negative, assume ``P1`` (see below) is the second keypoint of the line instead of the first
-                nl2 : str
+                nl2: str
                     Number of the second line to be hit. If negative, assume ``P3`` is the second keypoint of the line instead of the first.
 
-                ang1 : str
+                ang1: str
                     Angle of intersection (usually zero or 180) of generated line with tangent to first line.
 
-                ang2 : str
+                ang2: str
                     Angle of intersection (usually zero or 180) of generated line with tangent to second line.
 
-                phit1 : str
+                phit1: str
                     Number to be assigned to keypoint generated at hit location on first line (defaults to lowest available keypoint number ( :ref:`numstr` )).
 
-                phit2 : str
+                phit2: str
                     Number to be assigned to keypoint generated at hit location on second line (defaults to lowest available keypoint number ( :ref:`numstr` )).
 
                 Returns

pyproject.toml

@@ -29,6 +29,7 @@ dependencies = [
     "click>=7.0,<9.0.0",
     "importlib-metadata>=4.0",
     "pygithub>=1.59.1",
+    "inflect>=7.0.0",
     "lxml>=4.9.3",
     "numpy>=1.14.0,<1.25.0; python_version<'3.9'",
     "numpy>=1.14.0; python_version>='3.9'",
@@ -44,6 +45,7 @@ dependencies = [
 tests = [
     "black>=24.2.0",
     "click==8.1.7",
+    "inflect==7.4.0",
     "pygithub==2.4.0",
     "lxml==5.3.0",
     "numpy==2.1.2",
@@ -59,6 +61,7 @@ doc = [
     "ansys-sphinx-theme[autoapi]==1.1.5",
     "build>= 0.10.0",
     "flit>=3.8.0",
+    "inflect==7.4.0",
     "jupyter_sphinx==0.5.3",
     "numpy==2.1.2",
     "numpydoc==1.8.0",