docs: improve VerticalModelResult and VerticalObservation docstrings#655
Open
ecomodeller wants to merge 1 commit into
Open
docs: improve VerticalModelResult and VerticalObservation docstrings#655ecomodeller wants to merge 1 commit into
ecomodeller wants to merge 1 commit into
Conversation
Bring both vertical-profile docstrings to parity: state the long-format
(time, z) input contract explicitly, mention the dfs0 repeated-timestamp
convention, and switch to runnable Quarto {python} examples covering both
a long-format DataFrame and a dfs0 from docs/data/vertical/.
Also fixes several errors in the previous VerticalModelResult docstring:
wrong class name, duplicate mikeio.Dfs0 in the type list, missing
mikeio.Dataset, swapped lateral/zonal wording for x/y, opaque z_item
description, and a bogus "offset" option for keep_duplicates.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings the
VerticalModelResultandVerticalObservationdocstrings to parity: same wording for the long-format(time, z)input contract, same Notes block about the dfs0 repeated-timestamp convention, parallel parameter descriptions.Switches the examples to runnable Quarto
{python}blocks, matching the convention already used byQuantity,from_config, and the plotting helpers. Each class gets two examples — a long-formatpandas.DataFrameand a dfs0 file fromdocs/data/vertical/.Also fixes several errors in the previous
VerticalModelResultdocstring: wrong class name, duplicatemikeio.Dfs0in the type list, missingmikeio.Dataset, swapped lateral/zonal wording forx/y, opaquez_itemdescription, and a bogus"offset"option listed forkeep_duplicates.