exercism / python

Exercism exercises in Python.
https://exercism.org/tracks/python
MIT License
1.94k stars 1.29k forks source link

[Cater Waiter] Possible mistake in "categorize_dish" method docstring #3186

Closed rodrigosantiag closed 2 years ago

rodrigosantiag commented 2 years ago

I think that there's an error in param dish_ingredients param type description in `categorize_dish' docstring.

On "task" introduction is written:

Implement the categorize_dish(<dish_name>, <dish_ingredients>) function that takes a dish name and a **set** of that dish's' ingredients

But on method's docstring the dish_ingredients param type definition is as list

:param dish_ingredients: list - ingredients for the dish.

Looking to method's unit tests, we can see that, in fact, the second method argument is `set'

github-actions[bot] commented 2 years ago

🤖   🤖

Hi! 👋🏽 👋 Welcome to the Exercism Python Repo!

Thank you for opening an issue! 🐍  🌈 ✨


​          ◦ If you'd also like to make a PR to fix the issue, please have a quick look at the Pull Requests doc.
             We  💙  PRs that follow our Exercism & Track contributing guidelines!


💛  💙  While you are here... If you decide to help out with other open issues, you have our gratitude 🙌 🙌🏽.
Anything tagged with [help wanted] and without [Claimed] is up for grabs.
Comment on the issue and we will reserve it for you. 🌈 ✨

BethanyG commented 2 years ago

Hi @rodrigosantiag 👋🏽

Thanks for filing this issue! There is indeed a mistake - would you like to submit a PR to fix it? 😉 If not, I'll see if I can get to it this weekend. 😄

rodrigosantiag commented 2 years ago

Hi @BethanyG .

I opened the PR #3187

Regards

BethanyG commented 2 years ago

Hi @rodrigosantiag - Thank you for the PR! It is approved and merged. 😄 Closing this now as fixed. 🌟