DOC: Improve documentation #447
Conversation
|
Needs a proper read-through before merging, went a little bit fast in the swings, to use a well known Norwegian expression. But I am now blind to this, so need fresh eyes. |
perolavsvendsen
requested review from
mferrera,
janbjorge,
jcrivenaes and
anders-kiaer
docs/index.rst
Outdated
| such as pre- and post-processing jobs, and is compatible with Ensemble Reservoir Tool (ERT) | ||
| FORWARD_MODEL, within and outside RMS. |
There was a problem hiding this comment.
This reads a bit awkward ("is compatible with ERT FORWARD_MODEL, within and outside RMS"). Not sure on a better wording;
such as pre- and post-processing jobs from ERT and RMS workflows.
?
There was a problem hiding this comment.
Yes, I agree. I can rephrase that. It is remnant from existing text, where the main point probably was that it can be used both inside and outside RMS.
There was a problem hiding this comment.
Rephrased (happy to iterate further, don't think it's perfect)
docs/overview.rst
Outdated
| share/results/tables/mytable.csv | ||
| share/results/tables/.mytable.csv <-- New! |
There was a problem hiding this comment.
Would this actually be .mytable.csv.yml?
There was a problem hiding this comment.
Will also change "New!" to "metadata"
docs/preparations.rst
Outdated
| Use fmu-dataio in an FMU workflow | ||
| ============================================= |
There was a problem hiding this comment.
Should adjust the header bar length too
docs/preparations.rst
Outdated
| while ``coordinate_system`` and ``stratigraphic_column`` are not. | ||
|
|
||
| To find the information for your model, use `SMDA Viewer <https://opus.smda.equinor.com/smda_viewer/>`_. | ||
| You will see a number of topics, such as "Wellheader", "Well data" and below each topic |
There was a problem hiding this comment.
Nit: it's "Well Header" in the site
There was a problem hiding this comment.
Removed the examples, they were redundant I think
|
Failing on linting, seems unrelated to this so counting on that being solved in separate PR (?) |
|
Yep, ruff 0.2.0 came out today |
|
#448 inc. should resolve your linting issues. |
Merged, rebase and your lint warning should go away. |
Co-authored-by: Matthew Ferrera <matt.ferrera@gmail.com>
Co-authored-by: Matthew Ferrera <matt.ferrera@gmail.com>
janbjorge
force-pushed
the
441-improve-docs-smda
branch
from
6e2ab5f to
e129be3
Compare
This PR solves #441 but also includes some general restructuring and improvements to the documentation.