bp / bp/resqpy

Documented order of adding horizons to stratigraphic column is upside down

Open
#897 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
67
Forks
18
Avg merge
2h 26m
Merged PRs (30d)
1

Description

The resqpy [docs](https://resqpy.readthedocs.io/en/latest/_autosummary/resqpy.strata.StratigraphicColumnRank.html) for StratigraphicColumnRank for the `__init__` (ctor) method says this:

> **strata_uuid_list** (_list of uuid.UUID, optional_) – a list of uuids of existing stratigraphic unit interpretations, ordered from geologically oldest to youngest; ignored if uuid is not None

The correct order for RESQML is actually newest to oldest, contrary to the documentation.

This is admittedly not spelled out clearly in the RESQML 2.0.1 Technical Usage Guide.

I believe that only the documentation requires a change to correct this.

Contributor guide

Open the contributing guide

Research direction

Open the linked resqpy API documentation for StratigraphicColumnRank and inspect the __init__ parameter description for strata_uuid_list. Change the documented ordering from geologically oldest-to-youngest to newest-to-oldest, then verify that the rendered API documentation states the RESQML order correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.