Related GitHub issue: [Inventory Management] `list_inventory` docstring summary needs improvement · Issue #3683 · exercism/python · GitHub
Docstring summary of list_inventory
function is inconsistent.
A story behind
- Initially I’ve started an implementation of
list_inventory
function based on docstring. - Wrote the function, run tests and found the implementation doesn’t work.
- Then read instructions and found inconsistencies between docstring and instructions.
Proposed change
Currently | Suggested |
---|---|
"""Create a list containing all (item_name, item_count) pairs in inventory. |
"""Create a list containing only available (item_name, item_count > 0) pairs in inventory. |