[Inventory Management] `list_inventory` docstring summary needs improvement

Programming Python
1

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

  1. Initially I’ve started an implementation of list_inventory function based on docstring.
  2. Wrote the function, run tests and found the implementation doesn’t work.
  3. 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.

Screenshot

Screen Shot 2024-04-20 at 4 03 48 PM
Screen Shot 2024-04-20 at 4 03 48 PM2822×364 81.4 KB

2

Thanks for this! :smile:

I’ve reopened the issue and am happy to accept a PR for this and any typos or errors you find in the rest of the docs for the exercise.

1 Like
3

@BethanyG Hi! :wave: Hope you’re doing good.

Just to let you know that I’ve created a PR. :heavy_check_mark:

1 Like
4

Approved and merged! Thanks for submitting that. :smile:

1 Like