Transport-for-the-North / caf.toolkit

Toolkit of transport planning and appraisal functionalities.
https://caftoolkit.readthedocs.io/en/stable/
Other
0 stars 2 forks source link

cost_utils.CostDistribution Incorrect Attribute docstring #133

Closed Kieran-Fishwick-TfN closed 2 months ago

Kieran-Fishwick-TfN commented 2 months ago

the attributes outlined in the attribute docstring do not exist and are misleading as to how the class init works

BenTaylor-TfN commented 2 months ago

Could you vaguely outline what you'd like to see in the docs please? Current docs are here: https://caftoolkit.readthedocs.io/en/v0.7.3/api/cost_utils.CostDistribution.html#cost_utils.CostDistribution

These are showing up a little weird so some attention is required to tidy these up. A few suggestions from me: