New self-documenting code exercise#241
Merged
tbekolay merged 3 commits intoswcarpentry:gh-pagesfrom Jun 22, 2016
Merged
Conversation
Contributor
|
This is a useful example, but I think the bulk of it should be outside the challenge - the before/after example and accompanying text are lesson, and only the last paragraph is challenge. Can you please refactor and resubmit? |
Contributor
|
I like this example a lot: I even used it today in a SWC workshop to motivate the discussion for documentation. I think inserting it before the Testing and Documentation section would be good. I only worry that the term 'self-documenting code' may create the perception that as long as the names are human readable we do not need documentation, so I suggest removing the sentence which mentions it. |
Contributor
|
I merged and made the changes suggested by @gvwilson and @valentina-s. Thanks for your contribution @stuckyb! |
rgaiacs
pushed a commit
to rgaiacs/swc-python-novice-inflammation
that referenced
this pull request
May 6, 2017
changing testimonial to be less wordy
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
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.
I created a new exercise to introduce the concept of self-documenting code and give learners a chance to reflect on their coding style and practice reviewing code with a partner.