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

Clarify pending docs #2873

Merged
merged 1 commit into from
Feb 26, 2021
Merged

Clarify pending docs #2873

merged 1 commit into from
Feb 26, 2021

Conversation

pirj
Copy link
Member

@pirj pirj commented Feb 20, 2021

A summary of what is done here:

  1. Replaced a confusing "an example" docstring of a describe statement:
- describe "an example" do
+ describe "some behaviour" do
  1. Removed the misleading notion of a possibility to bypass hooks for any notation of a pending example:
- #`before(:example)` hooks are eval'd when you use the `pending`
- #   method within an example. If you want to declare an example `pending`
- #   and bypass the `before` hooks as well,

just because hooks are run either way.

  1. Wrapped the example of pending example group alias into describe to make a distinction between pending example alias and pending example-scope method:
it "is pending with no message" do
  pending
end

vs

describe "SomeClass" do
  pending "does not implement something yet" do
    # ...
  end
end
  1. Clarified the difference between different applications of pending when the failure happens inside before hook.

See the discussion:

@pirj pirj self-assigned this Feb 20, 2021
@pirj pirj mentioned this pull request Feb 20, 2021
@JonRowe JonRowe mentioned this pull request Feb 24, 2021
@pirj pirj force-pushed the clarify-pending-main branch from 214434b to ea829a1 Compare February 26, 2021 19:19
@pirj
Copy link
Member Author

pirj commented Feb 26, 2021

looks good otherwise

I consider this as good to merge.
The change is minimal, I intend to close the identical PR against 4-0-dev.

@pirj pirj merged commit f0d7b27 into main Feb 26, 2021
@JonRowe JonRowe deleted the clarify-pending-main branch February 26, 2021 20:35
JonRowe pushed a commit that referenced this pull request Feb 26, 2021
yujinakayama pushed a commit to yujinakayama/rspec-monorepo that referenced this pull request Oct 6, 2021
…nding-main

Clarify pending docs

---
This commit was imported from rspec/rspec-core@f0d7b27.
yujinakayama pushed a commit to yujinakayama/rspec-monorepo that referenced this pull request Oct 19, 2021
…nding-main

Clarify pending docs

---
This commit was imported from rspec/rspec-core@b8cea46.
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