Typo and details #29156
Open
Typo and details #29156
Conversation
This file contains 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
Headings should be surrounded by blank Lines Added blank lines to ruby document
wise-king-sullyman
requested review from
a team and
ZachBaird
and removed request for
a team
xandora
requested changes
Dec 6, 2024
Comment on lines
+9
to
+10
| procs | ||
| enumerables |
There was a problem hiding this comment.
The Because and This PR sections of the PR don't explain what this change is doing. Can you elaborate on this?
| @@ -41,7 +41,7 @@ end | |||
|
|
|||
| Next, create a test file for the user class in the spec directory named `user_spec.rb` and write the following tests for the `User` class to exercise the name, email and age attributes: | |||
|
|
|||
| ~~~ruby | |||
| ~~~~ruby | |||
There was a problem hiding this comment.
Code fences need to be wrapped with 3 tildes, not 4. This seems like an incorrect change.
| @@ -3,6 +3,7 @@ | |||
| So far you’ve been learning how to test code that you’ve written, but there’s a popular development process that flips that concept on its head. Rather than writing code, manually testing it until you get it working, then writing a test to make sure it stays working; you can write the test **before** the code, so that you don’t have to waste *any* time manually testing. Test Driven Development is the name of this inverted development process. | |||
|
|
|||
| ### Learning Outcomes | |||
|
|
|||
| @@ -30,6 +31,7 @@ This development cycle is known as red-green-refactor, and it’s at the heart o | |||
| One key aspect of the red-green-refactor cycle that *isn’t* in the name, is that the code you write to go from `red` to `green` should be the **minimum** amount required to pass the test. If you find that the functionality you’re adding actually does *more* than is being tested, that is a sign that your method is likely doing too much, or possibly that your tests aren’t testing all of the right functionality. | |||
|
|
|||
| #### TDD Examples | |||
|
|
|||
| @@ -210,6 +212,7 @@ TODO: Exercise: TDD a value object | |||
| TODO: Exercise: TDD a class that has a collaborator which doesn't exist yet using mocks | |||
|
|
|||
| ### Additional Resources | |||
|
|
|||
Comment on lines
+224
to
+227
| - [What does it mean for code to be test **driven**?](#what-is-tdd-and-why-do-it) | ||
| - [List four different advantages of TDD](#what-is-tdd-and-why-do-it) | ||
| - [What is the 3 part development cycle used for TDD?](#what-is-tdd-and-why-do-it) | ||
| - [How much code should be written when going from the `red` state to the `green` state of the red-green-refactor cycle?](#what-is-tdd-and-why-do-it) |
There was a problem hiding this comment.
Having link backs in the Knowledge Check section is good, but if they all point to the same section, then they might cause confusion when they all end up at the same place.
Additionally, you've missed a period at the end of the second check.
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.
Because
Linked the questions of the Knowledge Check to the tag document, this will help to speed up where the students can find the information or the answer to the questions. Additionally, merged the latest updates from the upstream main branch to keep this branch up to date.
This PR
In ruby/automated_testing/rspec_part_two_code_sharing.md I've made the link of the questions to the document.
Issue
Additional Information
Pull Request Requirements
location of change: brief description of changeformat, e.g.Intro to HTML and CSS lesson: Fix link textBecausesection summarizes the reason for this PRThis PRsection has a bullet point list describing the changes in this PRIssuesection