Related GitHub issue: [Card Games] `approx_average_is_average` docstring summary needs improvement · Issue #3674 · exercism/python · GitHub
Docstring summary of approx_average_is_average
function could be more clear.
A story behind
- Initially I’ve started an implementation of
approx_average_is_average
function based on docstring. - Wrote the function, ran tests and found the implementation doesn’t work.
- Then read instructions and found inconsistencies between docstring and instructions (see screenshot below).
Proposed change
Currently | Suggested |
---|---|
"""Return if an average is using (first + last index values ) OR ('middle' card) == calculated average. |
"""Return if the (average of first and last card values) OR ('middle' card) == calculated average. |