Skip to content

Commit

Permalink
FIX: avoid issues with new version of sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
jcrivenaes committed Oct 8, 2024
1 parent 25a6f75 commit feb3ad1
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/domain_conversion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Domain conversion
=================

In RMS it is possible to do domain conversion using the menu option, but in
some cases it convinient to be able to convert domains using a script. This
some cases it convenient to be able to convert domains using a script. This
module provides a method to convert domains in pure python.

The functions are based on that we have matching pairs of surfaces for the two
Expand Down
2 changes: 1 addition & 1 deletion docs/rms_import_localmodule.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Given that the library module is made inside the RMS GUI, here is an example::
The library is outside RMS
--------------------------

Sometimes it is convinient that the library is made outside RMS, and the same function can
Sometimes it is convenient that the library is made outside RMS, and the same function can
then be applied with a `path` keyword::

import fmu.tools as tools
Expand Down
2 changes: 1 addition & 1 deletion src/fmu/tools/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

_logger.debug("Being inside RMS/RMSAPI: %s", ROXAR)

from fmu.tools.extract_grid_zone_tops import extract_grid_zone_tops # noqa
from fmu.tools.extract_grid_zone_tops_etc import extract_grid_zone_tops # noqa
from fmu.tools.qcforward.qcforward import wellzonation_vs_grid # noqa
from fmu.tools.qcproperties.qcproperties import QCProperties # noqa
from fmu.tools.domainconversion.dconvert import DomainConversion # noqa
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Extract grid zone tops from wells."""

import pathlib
from typing import Any, Dict, Optional, Union

Expand Down
2 changes: 1 addition & 1 deletion src/fmu/tools/rms/import_localmodules.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

@no_type_check
def _detect_pyfile(path, module_root_name):
"""A module shall be named *.py, but may have different 'actual' name in RMS.
"""A module shall be named ``*.py``, but may have different 'actual' name in RMS.
Returns:
actual_file: e.g. mymodule_name_ondisk.py_1
Expand Down
2 changes: 1 addition & 1 deletion src/fmu/tools/rms/rename_rms_scripts.py
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ def _param_begin_end(self, params: List[str]) -> Tuple[int, int]:
return start, end

def _params_to_dict(self, lines: List[str]) -> Dict[str, str]:
"""Converts the list of lines representing _a single_ PSJParams
"""Converts the list of lines representing a single PSJParams
object into a dictionary containing its values.
"""
split_lines = [line.split("=", maxsplit=1) for line in lines]
Expand Down
21 changes: 12 additions & 9 deletions src/fmu/tools/sensitivities/create_design.py
Original file line number Diff line number Diff line change
Expand Up @@ -407,9 +407,10 @@ class SeedSensitivity:

# pylint: disable=too-few-public-methods
def __init__(self, sensname):
"""Args:
sensname (str): Name of sensitivity.
Defines SENSNAME in design matrix
"""Initiate method.
Args:
sensname (str): Name of sensitivity. Defines SENSNAME in design matrix.
"""
self.sensname = sensname
self.sensvalues = None
Expand Down Expand Up @@ -465,9 +466,10 @@ class SingleRealisationReference:

# pylint: disable=too-few-public-methods
def __init__(self, sensname):
"""Args:
sensname (str): Name of sensitivity.
Defines SENSNAME in design matrix
"""Initiate.
Args:
sensname (str): Name of sensitivity. Defines SENSNAME in design matrix.
"""
self.sensname = sensname
self.sensvalues = None
Expand Down Expand Up @@ -501,9 +503,10 @@ class BackgroundSensitivity:

# pylint: disable=too-few-public-methods
def __init__(self, sensname):
"""Args:
sensname (str): Name of sensitivity.
Defines SENSNAME in design matrix
"""Inititate
Args:
sensname (str): Name of sensitivity. Defines SENSNAME in design matrix.
"""
self.sensname = sensname
self.sensvalues = None
Expand Down

0 comments on commit feb3ad1

Please sign in to comment.