Include a blueprint for a function image #242
Merged
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
Improve the function lesson by including an SVG image of a function with annotation. Image helps to break up the text and more easily explain the parts of a function than just reading the text. * An explanation about how to reproduce the image is here, https://gist.github.com/wd15/2b4ffbe5ce0d0ddb8a5b. * This addition is part of the instructor training for Daniel Wheeler.
06-func.md
Outdated
| <!--- see https://gist.github.com/wd15/2b4ffbe5ce0d0ddb8a5b to | ||
| regenerate the above figure ---> | ||
|
|
||
| The function definition opens with the word `def`, |
Contributor
There was a problem hiding this comment.
Maybe you could use "keyword" instead of "word".
Contributor
|
Looks a good idea to me, but for some minor details. I usually explain this when teach and it's nice to have it in the lesson. Apart from the comments above, you use "signature" for the "def" part. But the signature is defined taking into account the arguments (and the return type in some other languages at least) [1]. I think better alternatives could be:
|
Contributor
Author
|
@iglpdc, thanks for the feedback -- will update the pull-request soon. |
Address swcarpentry#242 Change `signature` to `def keyword` in image and update associated sentence in text.
Contributor
Author
|
@iglpdc, updated without adding "function prototype", but used "def keyword" and modified the associated sentence. |
Contributor
|
Looks good! Thank you for your contribution. |
maxim-belkin
pushed a commit
that referenced
this pull request
May 17, 2018
Add note about the version of the style
zkamvar
pushed a commit
that referenced
this pull request
Apr 21, 2023
Address #242 Change `signature` to `def keyword` in image and update associated sentence in text.
zkamvar
pushed a commit
that referenced
this pull request
Apr 21, 2023
Include a blueprint for a function image
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Improve the function lesson by including an SVG image of a function
with annotation. Image helps to break up the text and more easily
explain the parts of a function than just reading the text.
https://gist.github.com/wd15/2b4ffbe5ce0d0ddb8a5b.