Skip to content

Commit a43be65

Browse files
author
Lisa Julia Nebel
committed
Adjust the wording and style on the common page
1 parent b282450 commit a43be65

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

python/sphinx_docs/docs/common.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ OPM Common Python Documentation
44
Note on Import Paths
55
--------------------
66

7-
In this documentation, some classes are referenced with their full import paths (e.g., opm.io.deck.DeckItem), while others are shown with just the class name. This distinction reflects how these classes are structured within the package:
7+
In this documentation, some classes are referenced with their full import paths (e.g., `opm.io.ecl.EGrid <common.html#opm.io.ecl.EGrid>`_), while others are shown with just the class name. This distinction reflects how these classes are structured within the package:
88

9-
- Fully Qualified Class Names: Classes displayed with their full import paths can be imported from their respective modules. They have constructors and can be directly instantiated in Python using the __init__ method. For example:
10-
.. code-block:: python
9+
- Fully Qualified Class Names: Classes displayed with their full import paths can be imported from their respective modules. They have constructors and can be directly instantiated in Python using the ``__init__`` method. For example:
1110

12-
from opm.io.deck import DeckItem
11+
.. code-block:: python
12+
13+
from opm.io.ecl import EGrid
1314
1415
1516
- Unqualified Class Names: Classes displayed with just their names, e.g., Connection, do not have constructors in Python and cannot be directly instantiated in Python. Objects of these classes might be return values of methods of other classes.

0 commit comments

Comments
 (0)