Skip to content

[Inventory Management] list_inventory docstring summary needs improvement #3683

@anym0us

Description

@anym0us

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions