Skip to content

Commit e1e9723

Browse files
authoredFeb 17, 2023
Fix minor typos (#1138)
1 parent a588f60 commit e1e9723

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed
 

‎CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ to build tooling on top of as it has stronger guarantees to be stable from versi
164164

165165
### Fixes
166166
- correcting some typos (#1064) [1403d3c]
167-
- fix flaky internal_integration interupt specs [2105ba3]
167+
- fix flaky internal_integration interrupt specs [2105ba3]
168168
- Correct busted link in README [be6b5b9]
169169

170170
### Maintenance

‎core_dsl.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,11 @@ type GinkgoWriterInterface interface {
9292
}
9393

9494
/*
95-
SpecContext is the context object passed into nodes that are subject to a timeout or need to be notified of an interrupt. It implements the standard context.Context interface but also contains additional helpers to provide an extensibility point for Ginkgo. (As an example, Gomega's Eventually can use the methods defined on SpecContext to provide deeper integratoin with Ginkgo).
95+
SpecContext is the context object passed into nodes that are subject to a timeout or need to be notified of an interrupt. It implements the standard context.Context interface but also contains additional helpers to provide an extensibility point for Ginkgo. (As an example, Gomega's Eventually can use the methods defined on SpecContext to provide deeper integration with Ginkgo).
9696
9797
You can do anything with SpecContext that you do with a typical context.Context including wrapping it with any of the context.With* methods.
9898
99-
Ginkgo will cancel the SpecContext when a node is interrupted (e.g. by the user sending an interupt signal) or when a node has exceeded it's allowed run-time. Note, however, that even in cases where a node has a deadline, SpecContext will not return a deadline via .Deadline(). This is because Ginkgo does not use a WithDeadline() context to model node deadlines as Ginkgo needs control over the precise timing of the context cancellation to ensure it can provide an accurate progress report at the moment of cancellation.
99+
Ginkgo will cancel the SpecContext when a node is interrupted (e.g. by the user sending an interrupt signal) or when a node has exceeded its allowed run-time. Note, however, that even in cases where a node has a deadline, SpecContext will not return a deadline via .Deadline(). This is because Ginkgo does not use a WithDeadline() context to model node deadlines as Ginkgo needs control over the precise timing of the context cancellation to ensure it can provide an accurate progress report at the moment of cancellation.
100100
*/
101101
type SpecContext = internal.SpecContext
102102

@@ -743,7 +743,7 @@ For example:
743743
os.SetEnv("FOO", "BAR")
744744
})
745745
746-
will register a cleanup handler that will set the environment variable "FOO" to it's current value (obtained by os.GetEnv("FOO")) after the spec runs and then sets the environment variable "FOO" to "BAR" for the current spec.
746+
will register a cleanup handler that will set the environment variable "FOO" to its current value (obtained by os.GetEnv("FOO")) after the spec runs and then sets the environment variable "FOO" to "BAR" for the current spec.
747747
748748
Similarly:
749749

‎docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2710,7 +2710,7 @@ It("can save books", func(ctx SpecContext) {
27102710
})
27112711
```
27122712

2713-
when such a node is detected Ginkgo will automatically supply a `SpecContext` object. This `SpecContext` object satisfies the `context.Context` interface and can be used anywhere a `context.Context` object is used. When a spec times out or is interupted by the user (see below) Ginkgo will cancel the `SpecContext` to signal to the spec that it is time to exit. In the case above, it is assumed that `libraryClient` knows how to return once `ctx` is cancelled.
2713+
when such a node is detected Ginkgo will automatically supply a `SpecContext` object. This `SpecContext` object satisfies the `context.Context` interface and can be used anywhere a `context.Context` object is used. When a spec times out or is interrupted by the user (see below) Ginkgo will cancel the `SpecContext` to signal to the spec that it is time to exit. In the case above, it is assumed that `libraryClient` knows how to return once `ctx` is cancelled.
27142714

27152715
Only setup and subjects nodes can be interruptible. Container nodes cannot be interrupted.
27162716

0 commit comments

Comments
 (0)
Please sign in to comment.