Skip to content

New self-documenting code exercise#241

Merged
tbekolay merged 3 commits intoswcarpentry:gh-pagesfrom
stuckyb:func_exercise
Jun 22, 2016
Merged

New self-documenting code exercise#241
tbekolay merged 3 commits intoswcarpentry:gh-pagesfrom
stuckyb:func_exercise

Conversation

@stuckyb
Copy link
Copy Markdown
Contributor

@stuckyb stuckyb commented Feb 22, 2016

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.

@gvwilson
Copy link
Copy Markdown
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?

@valentina-s
Copy link
Copy Markdown
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.

@tbekolay tbekolay merged commit 8318231 into swcarpentry:gh-pages Jun 22, 2016
@tbekolay
Copy link
Copy Markdown
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
maxim-belkin pushed a commit that referenced this pull request May 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants