Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add reference to Effective Testing with RSpec 3 #89

Closed
wants to merge 1 commit into from

Conversation

andyw8
Copy link
Contributor

@andyw8 andyw8 commented Apr 28, 2019

As discussed in #87.

I've gone for a style based on Martin Fowler's books – using an abbreviated name in the main body of the text.

From the book:

RSpec 3 fixed the confusing wording by renaming :each to :example and :all to :context. The old names :each and :all are still there for backward compatibility with existing specs, but we recommend using only the newer terms.

@andyw8 andyw8 force-pushed the add-efwr3-reference branch from 923933c to 7d4e985 Compare April 28, 2019 17:38
Copy link
Member

@pirj pirj left a comment

Choose a reason for hiding this comment

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

Loving it 👍

@@ -482,6 +482,7 @@ meant to be able to change with it.
* <a name="ambiguous-hook-scope"></a>
Use `:context` instead of the ambiguous `:all` scope in `before`/`after`
hooks.
<a href="#etwr3">[etwr3, Ch 7]</a>
Copy link
Member

Choose a reason for hiding this comment

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

How do you feel about using the same style as link below? E.g.:

<sup>[[etwr3, Chapter 7](#etwr3)]</sup>

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I considered that, but since they serve quite distinct purpose, I think it would be good to differentiate them:

  • The [link] links are 'utilitarian' – they provide a way to direct people to particular sections of the document, so can be less prominent.
  • The reference links are part of the narrative – they credit the origin of the guidelines, so should be more prominent.

What do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

I concur.

Copy link
Member

Choose a reason for hiding this comment

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

My concern is that it doesn't look too attractive
image

How do you feel about using a blockquote instead?

image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm, that seems semantically wrong, since it's not actually a quote.

Perhaps we can revisit this after #95?

Copy link
Member

Choose a reason for hiding this comment

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

WDYT of keeping this open to remind us to add proper references, and meanwhile play with AsciiDoc?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, it's not urgent.

@andyw8 andyw8 force-pushed the add-efwr3-reference branch from 7d4e985 to 7944910 Compare April 30, 2019 13:07
@pirj
Copy link
Member

pirj commented May 29, 2019

Let's figure out some generic solution to this since context for all the recommendations has been recently made untrackable (see #98).

@pirj pirj closed this May 29, 2019
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.

3 participants