Skip to content
This repository was archived by the owner on Nov 30, 2024. It is now read-only.

README improvements #1898

Merged
merged 10 commits into from
Mar 8, 2015
Merged

README improvements #1898

merged 10 commits into from
Mar 8, 2015

Conversation

myronmarston
Copy link
Member

My main goal here was to add a section on scope. After reading http://therealadam.com/2015/03/01/its-not-your-fault-if-your-tools-confuse-you/ I realized we don't document scope very well. While reading through what we had in the README I noticed a number of things that could be improved so I went ahead and addressed those.

README space is limited so why waste it mentioning
a feature we no longer support?
While it’s not normally needed (it has no code!),
some RSpec extensions depend directly on `rspec` and
in such situations you’ll need it to have the newer
version as well.
It’s important that you see the expectation fail
(it’s how you “test the test”, so to speak, and
you can confirm it gives you a good failure message),
so let’s not skip that step.
After reading http://therealadam.com/2015/03/01/its-not-your-fault-if-your-tools-confuse-you/,
I realized we do a poor job documenting the way the scopes work so this will hopefully help.
@therealadam
Copy link

The prose on scoping is great. The scoping example code was initially surprising to me due to calling a method on super, which is not a thing I usually see or expect to see. The example transliterating the DSL to a hand-coded Ruby class is great too.

@myronmarston
Copy link
Member Author

The prose on scoping is great. The scoping example code was initially surprising to me due to calling a method on super, which is not a thing I usually see or expect to see. The example transliterating the DSL to a hand-coded Ruby class is great too.

Thanks. I adapted the example from a prior response I had sent someone who had specifically asked if you can use super so it was a very arbitrary example that was attempting to demonstrate that...but it's totally unneeded here. I pushed an update...do you like that better?

@myronmarston
Copy link
Member Author

I also added a bit about how the examples would get run.

@therealadam
Copy link

Yep the code is exactly what I'd expect now.

~akk
http://therealadam.com

On Mar 6, 2015, at 1:29 PM, Myron Marston [email protected] wrote:

The prose on scoping is great. The scoping example code was initially surprising to me due to calling a method on super, which is not a thing I usually see or expect to see. The example transliterating the DSL to a hand-coded Ruby class is great too.

Thanks. I adapted the example from a prior response I had sent someone who had specifically asked if you can use super so it was a very arbitrary example that was attempting to demonstrate that...but it's totally unneeded here. I pushed an update...do you like that better?


Reply to this email directly or view it on GitHub.

integration, please use the `rspec-autotest` gem and see [rspec/rspec-autotest](https://github.com/rspec/rspec-autotest)
for details

## get started
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops ;)

JonRowe added a commit that referenced this pull request Mar 8, 2015
@JonRowe JonRowe merged commit 896291a into master Mar 8, 2015
@JonRowe JonRowe deleted the add-scope-docs branch March 8, 2015 23:52
@JonRowe
Copy link
Member

JonRowe commented Mar 8, 2015

This LGTM :) nice improvement, although I couldn't read the blog post that inspired it (blank page)

MatheusRich pushed a commit to MatheusRich/rspec-core that referenced this pull request Oct 30, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants