Skip to content

Commit 58a2622

Browse files
authored
Fix various typos in documentation (#1962)
1 parent 76a3d5c commit 58a2622

File tree

8 files changed

+30
-33
lines changed

8 files changed

+30
-33
lines changed

core/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ When property parsing functionality is not provided by the runner (i.e.
1313
properties from system properties, environment variables and the
1414
`cucumber.properties` file.
1515

16-
Note that options provided by `@CucumberOptions` takes precedence over the
16+
Note that options provided by `@CucumberOptions` take precedence over the
1717
properties file and CLI arguments take precedence over all.
1818

1919
Supported properties are:
@@ -40,10 +40,10 @@ Each property also has an `UPPER_CASE` and `snake_case` variant. For example
4040

4141
## Backend ##
4242

43-
Backends consists of two components, a `Backend` and `ObjectFactory`. They are
44-
respectively responsible for discovering glue classes, registering step definitions
43+
Backends consist of two components: a `Backend`, and an `ObjectFactory`. They are
44+
respectively responsible for discovering glue classes, registering step definitions,
4545
and creating instances of said glue classes. Backend and object factory
46-
implementations are discovered via SPI
46+
implementations are discovered via SPI.
4747

4848
## Plugin ##
4949

java8/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Cucumber Java8
22
==============
33

4-
Provides annotation based step definitions. To use add the `cucumber-java8` dependency to your pom.xml:
4+
Provides lambda based step definitions. To use add the `cucumber-java8` dependency to your pom.xml:
55

66
```xml
77
<dependencies>
@@ -86,7 +86,7 @@ Data table types can be declared by calling `DataTableType` in the constructor.
8686
Depending on the lambda type this will be either a:
8787
* `String` -> `io.cucumber.datatable.TableCellTranformer`
8888
* `Map<String,String>` -> `io.cucumber.datatable.TableEntry`
89-
* `List<String` -> `io.cucumber.datatable.TableRow`
89+
* `List<String>` -> `io.cucumber.datatable.TableRow`
9090
* `DataTable` -> `io.cucumber.datatable.TableTransformer`
9191

9292
```java

junit-platform-engine/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ either the Maven Antrun plugin or the Gradle JavaExec task.
6363
<artifactId>maven-antrun-plugin</artifactId>
6464
<executions>
6565
<execution>
66-
<!--Work around. Surefire does not use JUnits Test Engine discovery functionality -->
66+
<!--Work around. Surefire does not use JUnit's Test Engine discovery functionality -->
6767
<id>CLI-test</id>
6868
<phase>integration-test</phase>
6969
<goals>
@@ -91,8 +91,8 @@ either the Maven Antrun plugin or the Gradle JavaExec task.
9191
</plugins>
9292
</build>
9393
```
94-
```groovy
9594

95+
```groovy
9696
tasks {
9797
9898
val consoleLauncherTest by registering(JavaExec::class) {
@@ -120,7 +120,7 @@ tests in parallel is available as an opt-in feature. To enable parallel
120120
execution, set the `cucumber.execution.parallel.enabled` configuration
121121
parameter to `true`, e.g. in `junit-platform.properties`.
122122

123-
Cucumber supports JUnits `ParallelExecutionConfigurationStrategy` see the
123+
Cucumber supports JUnit's `ParallelExecutionConfigurationStrategy`; see the
124124
configuration options below.
125125

126126
### Exclusive Resources ###
@@ -133,7 +133,6 @@ either locked with a read-write-lock, or a read lock.
133133

134134
For example:
135135

136-
137136
```gherkin
138137
Feature: Exclusive resources
139138
@@ -149,7 +148,6 @@ Feature: Exclusive resources
149148
Given this reads resource a
150149
When it is executed it will
151150
Then it will not be executed concurrently with the first example
152-
153151
```
154152

155153
With this configuration:
@@ -235,7 +233,7 @@ The `UriSelector` supports URI's with a `line` query parameter:
235233
- `classpath:/com/example/example.feature?line=20`
236234
- `file:/path/to/com/example/example.feature?line=20`
237235

238-
Any `TestDescriptor` that matches the line *and* its descendents will be
236+
Any `TestDescriptor` that matches the line *and* its descendants will be
239237
included in the discovery result.
240238

241239
## Tags ##
@@ -267,7 +265,7 @@ The example below will execute `Another tagged scenario`.
267265
mvn verify -DexcludedGroups="Ignore" -Dgroups="Smoke | Sanity"
268266
```
269267

270-
For further information See the relevant documentation on how to select tags:
268+
For further information on how to select tags see the relevant documentation:
271269
* [Maven: Filtering by Tags](https://maven.apache.org/surefire/maven-surefire-plugin/examples/junit-platform.html)
272270
* [Gradle: Test Grouping](https://docs.gradle.org/current/userguide/java_testing.html#test_grouping)
273271
* [JUnit 5 Console Launcher: Options](https://junit.org/junit5/docs/current/user-guide/#running-tests-console-launcher-options)

junit/README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,27 +32,26 @@ public class RunCucumberTest {
3232
}
3333
```
3434

35-
This will execute all scenarios in same package as the runner, by default glue
35+
This will execute all scenarios in the same package as the runner; by default glue
3636
code is also assumed to be in the same
3737
package. The `@CucumberOptions` can be used to provide
3838
[additional configuration](https://docs.cucumber.io/cucumber/api/#list-configuration-options)
3939
to the runner.
4040

41-
4241
## Using JUnit Rules ##
4342

44-
Cucumber supports JUnits `@ClassRule`, `@BeforeClass` and `@AfterClass`
45-
annotations. These will executed before and
46-
after all scenarios. Using these is not recommended as it limits the portability
43+
Cucumber supports JUnit's `@ClassRule`, `@BeforeClass`, and `@AfterClass`
44+
annotations. These will be executed before and
45+
after all scenarios. Using these is not recommended as it limits portability
4746
between different runners; they may not
48-
execute correctly when using the commandline, [IntelliJ IDEA](https://www.jetbrains.com/help/idea/cucumber.html) or
47+
execute correctly when using the command line, [IntelliJ IDEA](https://www.jetbrains.com/help/idea/cucumber.html), or
4948
[Cucumber-Eclipse](https://github.com/cucumber/cucumber-eclipse). Instead it is
50-
recommended to use Cucumbers `Before` and `After` hooks.
49+
recommended to use Cucumber's `Before` and `After` hooks.
5150

5251
## Using other JUnit features ##
5352

5453
The Cucumber runner acts like a suite of a JUnit tests. As such other JUnit
55-
features such as Custom JUnit
54+
features like custom JUnit
5655
Listeners and Reporters can all be expected to work.
5756

5857
For more information on JUnit, see the [JUnit web site](http://www.junit.org).
@@ -63,8 +62,8 @@ Through [Assume](https://junit.org/junit4/javadoc/4.12/org/junit/Assume.html)
6362
and [Assumptions](https://junit.org/junit5/docs/5.0.0/api/org/junit/jupiter/api/Assumptions.html)
6463
JUnit4 and JUnit5 provide:
6564

66-
> a collection of utility methods that support conditional test execution based
67-
> on assumptions.
65+
> a collection of utility methods that support conditional test execution based
66+
> on assumptions.
6867
>
6968
> In direct contrast to failed assertions, failed assumptions do not result in a
7069
> test failure; rather, a failed assumption results in a test being aborted.
@@ -73,7 +72,7 @@ JUnit4 and JUnit5 provide:
7372
> execution of a given test method — for example, if the test depends on
7473
> something that does not exist in the current runtime environment.
7574
76-
The Cucumber runner supports `Assume` and will marked skipped scenarios as
75+
The Cucumber runner supports `Assume` and will mark skipped scenarios as
7776
skipped.
7877

7978
## Parallel Execution with Maven ##

needle/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Implements an ObjectFactory that instantiates glue code via [needle](http://needle.spree.de).
44

5-
This allows easy configurable dependency injection without relying on a full blown DI
6-
container and automatic mocking of all not explicitly specified dependencies.
5+
This allows easy, configurable dependency injection and automatic mocking of all not
6+
explicitly specified dependencies, without relying on a full blown DI container.
77

8-
See [needle tutorial](http://needle.spree.de/tutorial) for more information.
8+
See [needle tutorial](http://needle.spree.de/tutorial.html) for more information.

picocontainer/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ All step classes and their dependencies will be recreated for each
6060
scenario, even if the scenario in question does not use any steps from
6161
that particular class.
6262

63-
To improve performance it recommended to lazily create expensive
63+
To improve performance it is recommended to lazily create expensive
6464
resources.
6565

6666
```java
@@ -84,10 +84,10 @@ public class LazyWebDriver implements Webdriver {
8484
}
8585
```
8686

87-
Step classes or their dependencies which own resources which need cleanup
87+
Step classes or their dependencies which own resources requiring cleanup
8888
should implement `org.picocontainer.Disposable` as described in
8989
[PicoContainer - Component Lifecycle](http://picocontainer.com/lifecycle.html).
90-
These hooks will run after any Cucumber after hooks hooks.
90+
These hooks will run after any Cucumber after hooks.
9191

9292
## Customizing PicoContainer
9393

spring/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public class CucumberSpringConfiguration {
4242
}
4343
```
4444

45-
Note: Cucumber Spring uses Springs `TestContextManager` framework internally.
45+
Note: Cucumber Spring uses Spring's `TestContextManager` framework internally.
4646
As a result a single Cucumber scenario will mostly behave like a JUnit test.
4747

4848
For more information configuring Spring tests see:
@@ -71,7 +71,7 @@ public class MyStepDefinitions {
7171

7272
## Sharing State
7373

74-
Cucumber Spring creates an application context and using Springs
74+
Cucumber Spring creates an application context and uses Spring's
7575
`TestContextManager` framework internally. All scenarios as well as all other
7676
tests (e.g. JUnit) that use the same context configuration will share one
7777
instance of the Spring application. This avoids an expensive startup time.

testng/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public class RunCucumberTest extends AbstractTestNGCucumberTests {
6262
}
6363
```
6464

65-
#### Maven Surefire plugin configuation for parallel execution ####
65+
#### Maven Surefire plugin configuration for parallel execution ####
6666

6767
```xml
6868
<plugins>

0 commit comments

Comments
 (0)