Skip to content

Commit 4e85a26

Browse files
Modify doc sections with incorrect reference and rendering (#178)
Co-authored-by: Roberto Pastor Muela <roberto.pastormuela@ansys.com>
1 parent e1b41b2 commit 4e85a26

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

doc/source/getting_started/installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Consider installing using a `virtual environment <https://docs.python.org/3/libr
7171
Verify your installation
7272
------------------------
7373

74-
Check the :class:`Modeler() <ansys.geometry.core.modelar()>` connection by:
74+
Check the :class:`Modeler() <ansys.geometry.core.modeler()>` connection by:
7575

7676
.. code:: python
7777

doc/source/user_guide/index.rst

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,20 @@ PyGeometry basic overview
1919
=========================
2020

2121
PyGeometry is a Python wrapper for the Ansys Geometry Service. The key features of PyGeometry are:
22-
* Ability to use the library along side other Python libraries
22+
23+
* Ability to use the library alongside other Python libraries
2324
* Fluent based API for clean and easy coding experience
2425
* Built-in examples
2526

2627
Simple interactive example
2728
==========================
2829

29-
#. Start the geometry instance
30-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
30+
<!-- vale off -->
31+
1. Start the Geometry Service instance
32+
--------------------------------------
33+
<!-- vale on -->
3134

32-
The :class:`Modeler() <ansys.geometry.core.modelar>` class
35+
The :class:`Modeler() <ansys.geometry.core.modeler()>` class
3336
within the ``ansys-geometry-core`` library creates an instance of
3437
the Geometry Service. By default ``Modeler`` connects to ``127.0.0.1``
3538
(``'localhost'``) at the port 50051. You can change this by modifying
@@ -38,12 +41,14 @@ have to also modify this in your ``docker run`` command by changing ``<HOST-PORT
3841
Now, you can start the service with:
3942

4043
.. code:: python
41-
44+
4245
>>> from ansys.geometry.core import Modeler
4346
>>> modeler = Modeler()
4447
45-
#. Create Geometry models
46-
~~~~~~~~~~~~~~~~~~~~~~~~~
48+
<!-- vale off -->
49+
2. Create Geometry models
50+
-------------------------
51+
<!-- vale on -->
4752

4853
The Geometry Service is now active and you can start creating the geometry model
4954
by initializing the :ref:`Sketch <ref_sketch>` and :ref:`Primitives <ref_primitives>`.

0 commit comments

Comments
 (0)