Skip to content

Commit 3bb2c57

Browse files
authored
Fix various typos in documentation and code (#2660)
1 parent 1ffabd7 commit 3bb2c57

File tree

12 files changed

+21
-20
lines changed

12 files changed

+21
-20
lines changed

.spotless/intelij-idea.importorder renamed to .spotless/intellij-idea.importorder

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Organize import order using Intelij IDEA defaults
1+
# Organize import order using IntelliJ IDEA defaults
22
# Escaped hashes sort static methods last: https://github.com/diffplug/spotless/issues/306
33
1=
44
2=javax

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ We appreciate that. Do keep the following in mind:
77
* When you send a [pull requests](https://help.github.com/articles/using-pull-requests),
88
please include tests to go along with it.
99
* Want to paste some code or output? Put \`\`\` on a line above and below your
10-
code/output. See [Github Flavored Markdown](https://help.github.com/articles/github-flavored-markdown)'s
10+
code/output. See [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown)'s
1111
*Fenced Code Blocks* for details.
1212

1313
## Formatting Java

cucumber-archetype/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Cucumber Archetype
22

3-
This is a Maven Archetype for setting up an empty Cucumber project. Used by the
4-
the [10-Minute Cucumber Tutorial](https://docs.cucumber.io/guides/10-minute-tutorial/).
3+
This is a Maven Archetype for setting up an empty Cucumber project. Used by the [10-Minute Cucumber Tutorial](https://docs.cucumber.io/guides/10-minute-tutorial/).
54

65
```shell
76
mvn archetype:generate \

cucumber-bom/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Bill of Materials
22

3-
It is fairly common for one project to use more than one cucumber dependency. To
3+
It is fairly common for one project to use more than one Cucumber dependency. To
44
keep these version in sync a Bill of Materials can be used.
55

66
## Usage

cucumber-core/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Cucumber Core
44
Provides components needed to discover, parse and execute feature files. The
55
core is designed with a few extension systems and plugin points. You
66
typically don't depend directly on `cucumber-core` but rather use the different
7-
sub modules together e.g. `cucumber-junit` and `cucumber-java`.
7+
submodules together e.g. `cucumber-junit` and `cucumber-java`.
88

99
## Properties, Environment variables, System Options ##
1010

@@ -14,7 +14,7 @@ Note that the CLI arguments take precedence over all.
1414

1515
Note that the `cucumber-junit-platform-engine` is provided with properties
1616
by the Junit Platform rather than Cucumber. See
17-
[junit-platform-engine Configuration Options](../junit-platform-engine#configuration-options)
17+
[junit-platform-engine Configuration Options](../cucumber-junit-platform-engine#configuration-options)
1818
for more information.
1919

2020
Supported properties are:

cucumber-deltaspike/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,13 @@ public class BellyStepdefs {
2525
private Belly belly;
2626

2727
//normal step code ...
28+
}
2829
```
2930

3031
This ObjectFactory doesn't start or stop any [Scopes](https://docs.oracle.com/javaee/6/tutorial/doc/gjbbk.html), so all beans live inside the default scope (Dependent). Now cucumber requested a instance of your stepdefinitions for every step, which means cdi create a new instance for every step and for all injected fields. This behaviour makes it impossible to share a state inside a szenario.
3132

3233
To bybass this, you must annotate your class(es) with `@javax.inject.Singleton`:
33-
1. on stepdefintions: now the ojectfactory will creates only one instance include injected fields per scenario and both injected fields and stepdefinitions can be used to share state inside a scenario.
34+
1. on stepdefintions: now the ojectfactory will create only one instance include injected fields per scenario and both injected fields and stepdefinitions can be used to share state inside a scenario.
3435
2. on any other class: now the objectfactory will create a new instance of your stepdefinitions per step and stepdefinitions can not be used to share state inside a scenario, only the annotated classes can be used to share state inside a scenario
3536

3637
you can also combine both approaches.
@@ -43,10 +44,11 @@ public class BellyStepdefs {
4344
private Belly belly;
4445

4546
//normal step code ...
47+
}
4648
```
4749
It is not possible to use any other scope than Dependent this means alsoi it is not possible to share a state over two or more scenarios, every scenario start with a clean environment.
4850

49-
To enable this objectfactory add the folling dependency to your classpath:
51+
To enable this objectfactory add the following dependency to your classpath:
5052
```xml
5153
<dependency>
5254
<groupId>io.cucumber</groupId>

cucumber-java/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Notes:
156156

157157
1. When used in combination with Junit 5, Maven Surefire, and/or Failsafe use
158158
version `3.0.0-M5` or later.
159-
2. When used in combination with Junit 5 and InteliJ IDEA failures in before
159+
2. When used in combination with Junit 5 and IntelliJ IDEA failures in before
160160
all and after all hooks do not fail a test run.
161161

162162
### Before / After

cucumber-java8/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ public class StepDefinitions implements En {
240240
public StepDefinitions() {
241241
DataTableType((Map<String, String> entry) -> new User(
242242
entry.get("firstname"),
243-
entry.get("lastname")
243+
entry.get("lastname"),
244244
entry.get("nationality")
245245
));
246246

cucumber-junit/README.md

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

4-
Use JUnit to execute cucumber scenarios. To use add the `cucumber-junit`
4+
Use JUnit to execute Cucumber scenarios. To use add the `cucumber-junit`
55
dependency to your pom.xml:
66

77
```xml
@@ -45,16 +45,16 @@ annotations. These will be executed before and
4545
after all scenarios. Using these is not recommended as it limits portability
4646
between different runners; they may not
4747
execute correctly when using the command line, [IntelliJ IDEA](https://www.jetbrains.com/help/idea/cucumber.html), or
48-
[Cucumber-Eclipse](https://github.com/cucumber/cucumber-eclipse). Instead it is
49-
recommended to [use Cucumber's hooks](../java#beforeall--afterall).
48+
[Cucumber-Eclipse](https://github.com/cucumber/cucumber-eclipse). Instead, it is
49+
recommended to [use Cucumber's hooks](../cucumber-java#beforeall--afterall).
5050

5151
## Using other JUnit features ##
5252

5353
The Cucumber runner acts like a suite of a JUnit tests. As such other JUnit
5454
features like custom JUnit
5555
Listeners and Reporters can all be expected to work.
5656

57-
For more information on JUnit, see the [JUnit web site](http://www.junit.org).
57+
For more information on JUnit, see the [JUnit website](http://www.junit.org).
5858

5959
## Assume ##
6060

cucumber-testng/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Cucumber TestNG
22
==============
33

4-
Use TestNG to execute cucumber scenarios. To use add the `cucumber-testng` dependency to your pom.
4+
Use TestNG to execute Cucumber scenarios. To use add the `cucumber-testng` dependency to your pom.
55

66
```xml
77
<dependencies>

0 commit comments

Comments
 (0)