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

docs: emphasize gem backtrace exclusion patterns #1847

Merged
merged 1 commit into from
Jan 15, 2015

Conversation

e2
Copy link
Contributor

@e2 e2 commented Jan 14, 2015

Give better example for filtering with multiple gems

```

For more control over which lines to ignore, you can assign a list of
patterns the `backtrace_exclusion_patterns` option.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

should be "patterns for the"

Copy link
Member

Choose a reason for hiding this comment

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

Actually, should be "patterns to the", I think. Besides assigning to backtrace_exclusion_patterns, you can also append to it, and that's probably worth calling out here.

@myronmarston
Copy link
Member

Nice improvement, @e2, I left a few comments. Ignore the build failure for now; it's due to a new aruba release that broke us.

@e2 e2 force-pushed the doc_multiple_backtrace_gem_filter branch from e9b4297 to 56ed92b Compare January 15, 2015 02:16
@e2
Copy link
Contributor Author

e2 commented Jan 15, 2015

I didn't wrap in RSpec.configure do (...) end because I added the patterns example code. Besides, the examples below use RSpec.configure blocks - which clear any confusion.

@myronmarston
Copy link
Member

Thanks, @e2. One other thing I forgot to mention before: on relish, hand-wrapped markdown doesn't render well because it puts line breaks everywhere you put one rather than treating it as a free-flowing paragraph. I used to push to a relish staging environment (https://relishapp.com/rspec-staging) so that I could see how it renders and adjust my line breaks accordingly until I realized it was simpler just to not put any line breaks in the middle of a paragraph, letting relish's markdown render put them at the appropriate places. So now I find it easier/better to write relish narrative paragraphs as one long unbroken line each. Do you mind changing your paragraphs to that?

With that in place, this'll be good to merge. Thanks!

@myronmarston
Copy link
Member

Regarding the failed build...I just merged #1848 which fixes it, so do you mind rebasing against master so that the builds here include that? Then we should be able to see a green build here which is always nice.

@e2 e2 force-pushed the doc_multiple_backtrace_gem_filter branch from 56ed92b to 0011ab8 Compare January 15, 2015 20:30
@e2
Copy link
Contributor Author

e2 commented Jan 15, 2015

I'm not sure if I understood correctly about the newlines - let me know if I didn't (I'm not sure). I tried not to change the original at first (I had newlines pretty much like in the original), so I don't see how I "introduced" any problems.

@myronmarston
Copy link
Member

I'm not sure if I understood correctly about the newlines - let me know if I didn't (I'm not sure)

That's not what I meant. Maybe an example will make what I meant clearer (sorry that my description wasn't clear!). Check out the long unwrapped lines that were added in this PR, particularly the linked line and discussion:

https://github.com/rspec/rspec-core/pull/1842/files#diff-55a2a0f3cabfec543152971929f30a32R15

@e2 e2 force-pushed the doc_multiple_backtrace_gem_filter branch from 0011ab8 to cd32c7c Compare January 15, 2015 22:26
@e2
Copy link
Contributor Author

e2 commented Jan 15, 2015

(facepalm) - I get it now.

Fixed.

Let me know if there's anything else.

@myronmarston
Copy link
Member

👍 Will merge when green. Thanks!

@e2
Copy link
Contributor Author

e2 commented Jan 15, 2015

Thanks as well! I'll start with a PR next time.

myronmarston added a commit that referenced this pull request Jan 15, 2015
docs: emphasize gem backtrace exclusion patterns
@myronmarston myronmarston merged commit 198abcb into rspec:master Jan 15, 2015
@e2 e2 deleted the doc_multiple_backtrace_gem_filter branch January 15, 2015 22:45
MatheusRich pushed a commit to MatheusRich/rspec-core that referenced this pull request Oct 30, 2020
docs: emphasize gem backtrace exclusion patterns
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.

2 participants