Skip to content

Commit

Permalink
Updated docstring for ArbModel
Browse files Browse the repository at this point in the history
  • Loading branch information
NowanIlfideme committed May 10, 2023
1 parent 5c2f805 commit 9937c07
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/pydantic_kedro/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,12 @@ class ArbModel(BaseModel):
This also supports type hints for `pydantic_kedro` in the configuration:
- `kedro_map`, which maps a type to a dataset constructor to use.
- `kedro_default`, which specifies the default dataset type to use.
- `kedro_default`, which specifies the default dataset type to use
([kedro.extras.datasets.pickle.PickleDataSet][])
These are NOT currently inherited (TODO).
The default dataset type that's used is [kedro.extras.datasets.pickle.PickleDataSet][]
These are pseudo-inherited, see [config-inheritence][].
You do not actually need to inherit from `ArbModel` for this to work, however it can help with
type completion in your IDE.
"""

Config = ArbConfig

0 comments on commit 9937c07

Please sign in to comment.