Documentation #2
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Documentation
DanaJohanna
reviewed
May 19, 2021
There was a problem hiding this comment.
+Clear what your program will do.
-Less clear how your program will work. You could write down for your input and output more clearly what it is exactly. How are ingredients presented? How do you present recipes? How do you relate these concepts to each other?
Sebasdevrs
reviewed
May 19, 2021
|
|
||
| def recipes(): | ||
| """ | ||
| Description of the function |
There was a problem hiding this comment.
Looks good! Perhaps you could start off with a small introduction of what the function is for. That might also make the input and output slightly easier to interpret.
| Output: | ||
| All recipes that require only those ingredients | ||
| :return: |
There was a problem hiding this comment.
I'm not sure what :return: does. Do you mean to explain what the package returns, here?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Assignment 2