diff --git a/docs/domain_conversion.rst b/docs/domain_conversion.rst index b997fb94..0bdd25d7 100644 --- a/docs/domain_conversion.rst +++ b/docs/domain_conversion.rst @@ -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 diff --git a/docs/rms_import_localmodule.rst b/docs/rms_import_localmodule.rst index 9123ccee..db44d4e8 100644 --- a/docs/rms_import_localmodule.rst +++ b/docs/rms_import_localmodule.rst @@ -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 diff --git a/src/fmu/tools/__init__.py b/src/fmu/tools/__init__.py index 9fb92c59..f8b3fad6 100644 --- a/src/fmu/tools/__init__.py +++ b/src/fmu/tools/__init__.py @@ -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 diff --git a/src/fmu/tools/extract_grid_zone_tops.py b/src/fmu/tools/extract_grid_zone_tops_etc.py similarity index 99% rename from src/fmu/tools/extract_grid_zone_tops.py rename to src/fmu/tools/extract_grid_zone_tops_etc.py index d2e471c7..7f15aa10 100644 --- a/src/fmu/tools/extract_grid_zone_tops.py +++ b/src/fmu/tools/extract_grid_zone_tops_etc.py @@ -1,3 +1,5 @@ +"""Extract grid zone tops from wells.""" + import pathlib from typing import Any, Dict, Optional, Union diff --git a/src/fmu/tools/rms/import_localmodules.py b/src/fmu/tools/rms/import_localmodules.py index 1240fcbd..215fcc24 100644 --- a/src/fmu/tools/rms/import_localmodules.py +++ b/src/fmu/tools/rms/import_localmodules.py @@ -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 diff --git a/src/fmu/tools/rms/rename_rms_scripts.py b/src/fmu/tools/rms/rename_rms_scripts.py index ec28bad2..40e8557a 100644 --- a/src/fmu/tools/rms/rename_rms_scripts.py +++ b/src/fmu/tools/rms/rename_rms_scripts.py @@ -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] diff --git a/src/fmu/tools/sensitivities/create_design.py b/src/fmu/tools/sensitivities/create_design.py index 614e2b98..d3789624 100644 --- a/src/fmu/tools/sensitivities/create_design.py +++ b/src/fmu/tools/sensitivities/create_design.py @@ -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 @@ -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 @@ -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