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

Clarify pending docs #2872

Closed
wants to merge 1 commit into from
Closed

Clarify pending docs #2872

wants to merge 1 commit into from

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 added this to the 4.0 milestone Feb 20, 2021
@pirj pirj mentioned this pull request Feb 20, 2021
@JonRowe
Copy link
Member

JonRowe commented Feb 24, 2021

See feedback on #2873

@pirj
Copy link
Member Author

pirj commented Feb 26, 2021

#2873 has been merged to main. I guess we'll rebase on it when will be merging 4-0-dev anyway.

@pirj pirj closed this Feb 26, 2021
@pirj pirj deleted the clarify-pending-4-0 branch February 26, 2021 19:22
@JonRowe
Copy link
Member

JonRowe commented Feb 26, 2021

Thanks @pirj, I cherry-picked this across

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.

2 participants