Context
PR #149 converted docstrings to Google-style but carried over stale
attribute names from an older version of the codebase.
Problem / Current Behaviour
`Wrapper.RRMModel` docstring lists Model attributes `sp_prec`,
`sp_et`, `sp_temp`, `sp_par`, `p2`, `kub`, `klb` — none of
which exist on `Catchment`. The actual attribute names are `Prec`,
`ET`, `Temp`, `Parameters`, `conversion_factor`, etc.
Affected locations
| File |
Symbol |
Notes |
| `src/Hapi/wrapper.py:58-88` |
`Wrapper.RRMModel` |
Wrong attr names |
| `src/Hapi/wrapper.py:94-120` |
`Wrapper.RRMWithlake` |
May also be stale |
Proposed Solution
Update the docstring attribute lists to match `Catchment.init`
attribute names: `Prec`, `ET`, `Temp`, `Parameters`,
`FlowAccArr`, `FlowDirArr`, `LumpedModel`, `InitialCond`,
`q_init`, `Snow`, `CatArea`, `conversion_factor`, etc.
Effort Estimate
Size: `XS`
Definition of Done
Context
PR #149 converted docstrings to Google-style but carried over stale
attribute names from an older version of the codebase.
Problem / Current Behaviour
`Wrapper.RRMModel` docstring lists Model attributes `sp_prec`,
`sp_et`, `sp_temp`, `sp_par`, `p2`, `kub`, `klb` — none of
which exist on `Catchment`. The actual attribute names are `Prec`,
`ET`, `Temp`, `Parameters`, `conversion_factor`, etc.
Affected locations
Proposed Solution
Update the docstring attribute lists to match `Catchment.init`
attribute names: `Prec`, `ET`, `Temp`, `Parameters`,
`FlowAccArr`, `FlowDirArr`, `LumpedModel`, `InitialCond`,
`q_init`, `Snow`, `CatArea`, `conversion_factor`, etc.
Effort Estimate
Size: `XS`
Definition of Done
`Catchment` attribute names