Introduction to RSpec: Fix all top level "describe" blocks to "Rspec.describe"#30997
Merged
KevinMulhern merged 3 commits intoTheOdinProject:mainfrom Apr 21, 2026
Merged
Conversation
ManonLef
requested review from
a team and
CouchofTomato
and removed request for
a team
| ``` | ||
|
|
||
| <span id='keyword-it'>The `it` keyword defines an individual example (aka, test)</span>. `it` takes a string argument and is also passed a block. This block is where our expectations of a method are expressed. In this particular case, when we pass 5 and 2 to the `#add` method, we expect it to return 7. This is concisely expressed in our expectation clause, which uses one of [RSpec's equality matchers](http://rspec.info/features/3-12/rspec-expectations/built-in-matchers/equality/), `eql`: | ||
| While both syntax are valid, stick to `Rspec.describe` for now. Anyway, <span id='keyword-it'>the `it` keyword defines an individual example (aka, test)</span>. `it` takes a string argument and is also passed a block. This block is where our expectations of a method are expressed. In this particular case, when we pass 5 and 2 to the `#add` method, we expect it to return 7. This is concisely expressed in our expectation clause, which uses one of [RSpec's equality matchers](http://rspec.info/features/3-12/rspec-expectations/built-in-matchers/equality/), `eql`: |
Member
There was a problem hiding this comment.
While both syntax are valid, stick to
Rspec.describefor now.
Nit: Because we're recommending that learners don't use it. What do you think about removing the the second example that shows the describe without the RSpec prefix? does it muddy the water and make things harder to understand?
Contributor
Author
There was a problem hiding this comment.
@KevinMulhern Now that you mention it, I don't think it does for the following reasons:
- We did say we want users to use RSpec with its module name without explaining why and some folks might feel strongly to question this, which is a fair concern, and someone will have to explain it on Discord again
- It really is an either or option, to use or not to use the module name (Hamlet intended yes) would probably not matter too much for the kind of tests learners will be writing within TOP, both on the Ruby and Rails course. I've never worked with Ruby extensively before so I am not sure if there is any point in which learners will have to research about monkey-patching like you mentioned in this comment of yours. Anyhow, in the spirit of "conventions over configuration" and trusting learners will be able to research their way out, I think it's okay to remove the second example
Member
There was a problem hiding this comment.
Those sounds like solid reasons to me! would you like to remove it in this PR?
Contributor
Author
There was a problem hiding this comment.
@KevinMulhern I'll get that done in a flash!
| project | ||
| |__lib | ||
| | |__script.rb | ||
| | |__calculator.rb |
KevinMulhern
approved these changes
Apr 21, 2026
Member
KevinMulhern
left a comment
KevinMulhern
left a comment
There was a problem hiding this comment.
Thanks for doing this @ZackHoang, this lesson is looking way better 💪
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.
Because
Currently, this lesson is mistakenly introducing the top level
describeblock twices. This PR re-introduces theRspec.describesyntax to be explicit about how RSpec tests should be written.This PR
describeblocks toRSpec.describeIssue
Closes #30988
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