Documentation: Readme - Add workload philosophy section.#569
Merged
kotp merged 2 commits intoexercism:masterfrom Apr 26, 2017
Merged
Documentation: Readme - Add workload philosophy section.#569kotp merged 2 commits intoexercism:masterfrom
kotp merged 2 commits intoexercism:masterfrom
Conversation
The Workload philosophy section gives some information about why an educational workload layout is preferable to a concise one liner. Link to the workload philosophy section from the first mention of workload.
Insti
changed the title
hilary
reviewed
Apr 25, 2017
| ``` | ||
|
|
||
| This provides the information the student needs to derive the code to pass the test in a clear and consistent manner. | ||
| Intention revealing variable names are used to illustrate the purpose of the individual elements of what could otherwise be a one line assertion. The values used in `detector`,`anagrams` and `expected` will all vary by test. |
Contributor
There was a problem hiding this comment.
"Provide the information the student needs to derive the code to pass the test in a clear and consistent manner. Illustrate the purpose of the individual elements of the assertion by using meaningful variable names."
hilary
reviewed
Apr 25, 2017
|
|
||
| Within the test workload we want to prioritize educational value over expert comprehension and want to make sure that things are clear to people who may not be familiar with Minitest and even Ruby. | ||
|
|
||
| Therefore a multi line workload is preferred. |
Contributor
There was a problem hiding this comment.
I would just omit this line and put the (revised paragraph) below the example here.
Contributor
|
Looks great to me! 👍 |
Member
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
3 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.
Add a workload philosophy section to
Readme.mdThe Workload philosophy section gives some information about why an
educational workload layout is preferable to a concise one liner.
Inspired by: #567 (review)