Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Inventory Management] Update 'list_inventory' docstring summary #3684

Merged
merged 1 commit into from
Apr 21, 2024
Merged

[Inventory Management] Update 'list_inventory' docstring summary #3684

merged 1 commit into from
Apr 21, 2024

Conversation

anym0us
Copy link
Contributor

@anym0us anym0us commented Apr 21, 2024

Docstring summary of list_inventory function is inconsistent. This is a fix for issue #3683.

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

@github-actions GitHub Actions

This comment was marked as resolved.

Sign in to view
@github-actions github-actions bot closed this Apr 21, 2024
@BethanyG BethanyG reopened this Apr 21, 2024
@BethanyG BethanyG linked an issue Apr 21, 2024 that may be closed by this pull request
[Inventory Management] list_inventory docstring summary needs improvement #3683
Closed
BethanyG
BethanyG approved these changes Apr 21, 2024
View reviewed changes
Copy link
Member

@BethanyG BethanyG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! 😄

Closes #3683

@BethanyG BethanyG merged commit 1fd9f1c into exercism:main Apr 21, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BethanyG BethanyG BethanyG approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Inventory Management] list_inventory docstring summary needs improvement
2 participants
@anym0us @BethanyG