Skip to content

Commit 86df8ce

Browse files
RobPasMuepre-commit-ci[bot]AlejandroFernandezLuces
authored
docs: error on docstrings for launcher methods (#750)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Alex Fernandez <21alex295@gmail.com>
1 parent 9850100 commit 86df8ce

File tree

1 file changed

+33
-26
lines changed

1 file changed

+33
-26
lines changed

src/ansys/geometry/core/connection/launcher.py

Lines changed: 33 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -304,10 +304,11 @@ def launch_modeler_with_geometry_service(
304304
By default its value is ``False``.
305305
log_level : int, optional
306306
Backend's log level from 0 to 3:
307-
0: Chatterbox
308-
1: Debug
309-
2: Warning
310-
3: Error
307+
308+
* ``0``: Chatterbox
309+
* ``1``: Debug
310+
* ``2``: Warning
311+
* ``3``: Error
311312
312313
The default is ``2`` (Warning).
313314
timeout : int, optional
@@ -339,8 +340,7 @@ def launch_modeler_with_geometry_service(
339340
logs, traces enabled and a ``300`` seconds timeout:
340341
341342
>>> from ansys.geometry.core import launch_modeler_with_geometry_service
342-
>>> modeler = launch_modeler_with_geometry_service(product_version = 232,
343-
host="10.171.22.44",
343+
>>> modeler = launch_modeler_with_geometry_service(host="10.171.22.44",
344344
port=5001,
345345
log_level=0,
346346
enable_trace= True,
@@ -368,7 +368,11 @@ def launch_modeler_with_discovery(
368368
"""
369369
Start Ansys Discovery locally using the ``ProductInstance`` class.
370370
371-
When calling this method, a standalone Geometry service is started.
371+
.. note::
372+
373+
Support for Ansys Discovery is restricted to Ansys 24.1 onwards.
374+
375+
When calling this method, a standalone Discovery session is started.
372376
By default, if an endpoint is specified (by defining `host` and `port` parameters)
373377
but the endpoint is not available, the startup will fail. Otherwise, it will try to
374378
launch its own service.
@@ -380,22 +384,23 @@ def launch_modeler_with_discovery(
380384
the latest. Default is ``None``.
381385
If a specific product version is requested but not installed locally,
382386
a SystemError will be raised.
383-
Possible values:
384-
Ansys products Versions and their corresponding int values:
385-
23.2 -> value : 232
386-
24.1 -> value : 241
387+
388+
**Ansys products versions and their corresponding int values:**
389+
390+
* ``241`` : Ansys 24R1
387391
host: str, optional
388-
IP address at which the Geometry service will be deployed. By default,
392+
IP address at which the Discovery session will be deployed. By default,
389393
its value will be ``localhost``.
390394
port : int, optional
391395
Port at which the Geometry service will be deployed. By default, its
392396
value will be ``None``.
393397
log_level : int, optional
394398
Backend's log level from 0 to 3:
395-
0: Chatterbox
396-
1: Debug
397-
2: Warning
398-
3: Error
399+
400+
* ``0``: Chatterbox
401+
* ``1``: Debug
402+
* ``2``: Warning
403+
* ``3``: Error
399404
400405
The default is ``2`` (Warning).
401406
api_version: ApiVersions, optional
@@ -460,7 +465,7 @@ def launch_modeler_with_spaceclaim(
460465
"""
461466
Start Ansys SpaceClaim locally using the ``ProductInstance`` class.
462467
463-
When calling this method, a standalone Geometry service is started.
468+
When calling this method, a standalone SpaceClaim session is started.
464469
By default, if an endpoint is specified (by defining `host` and `port` parameters)
465470
but the endpoint is not available, the startup will fail. Otherwise, it will try to
466471
launch its own service.
@@ -472,22 +477,24 @@ def launch_modeler_with_spaceclaim(
472477
the latest. Default is ``None``.
473478
If a specific product version is requested but not installed locally,
474479
a SystemError will be raised.
475-
Possible values:
476-
Ansys products Versions and their corresponding int values:
477-
23.2 -> value : 232
478-
24.1 -> value : 241
480+
481+
**Ansys products versions and their corresponding int values:**
482+
483+
* ``232`` : Ansys 23R2 SP1
484+
* ``241`` : Ansys 24R1
479485
host: str, optional
480-
IP address at which the Geometry service will be deployed. By default,
486+
IP address at which the SpaceClaim session will be deployed. By default,
481487
its value will be ``localhost``.
482488
port : int, optional
483489
Port at which the Geometry service will be deployed. By default, its
484490
value will be ``None``.
485491
log_level : int, optional
486492
Backend's log level from 0 to 3:
487-
0: Chatterbox
488-
1: Debug
489-
2: Warning
490-
3: Error
493+
494+
* ``0``: Chatterbox
495+
* ``1``: Debug
496+
* ``2``: Warning
497+
* ``3``: Error
491498
492499
The default is ``2`` (Warning).
493500
api_version: ApiVersions, optional

0 commit comments

Comments
 (0)