Skip to content

Commit 4dc2a02

Browse files
committed
document proof reading
1 parent 14be19d commit 4dc2a02

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ by using the following [maven-surefire-plugin configuration](http://maven.apache
395395
<version>${maven.surefire.version}</version>
396396
<configuration>
397397
<includes>
398-
<include>AnimalsTest.java</include>
398+
<include>animals/AnimalsTest.java</include>
399399
</includes>
400400
</configuration>
401401
</plugin>
@@ -523,9 +523,9 @@ be more than sufficient for your Continuous Integration or test-automation needs
523523
Here's a reminder that running any [single JUnit test via Maven](https://maven.apache.org/surefire/maven-surefire-plugin/examples/single-test.html)
524524
can be done by:
525525
```
526-
mvn test -Dtest=CatsTest
526+
mvn test -Dtest=CatsRunner
527527
```
528-
Where `CatsTest` is the JUnit class name (in any package) you wish to run.
528+
Where `CatsRunner` is the JUnit class name (in any package) you wish to run.
529529

530530
Karate is flexible, you can easily over-write config variables within each individual test-script -
531531
which is very convenient when in dev-mode or rapid-prototyping.
@@ -542,7 +542,7 @@ import org.junit.BeforeClass;
542542
import org.junit.runner.RunWith;
543543

544544
@RunWith(Karate.class)
545-
public class CatsTest {
545+
public class CatsRunner {
546546

547547
@BeforeClass
548548
public static void before() {
@@ -606,7 +606,7 @@ script-steps are treated the same no matter whether they start with the keyword
606606
whatever makes sense for you. You could even have all the steps start with `When`
607607
and Karate won't care.
608608

609-
In fact Cucumber supports the ['catch-all' symbol `*`](https://www.relishapp.com/cucumber/cucumber/docs/gherkin/using-star-notation-instead-of-given-when-then) -
609+
In fact Cucumber supports the [catch-all symbol '`*`'](https://www.relishapp.com/cucumber/cucumber/docs/gherkin/using-star-notation-instead-of-given-when-then) -
610610
instead of forcing you to use `Given`, `When` or `Then`. This is perfect for those
611611
cases where it really doesn't make sense - for example the [`Background`](#script-structure)
612612
section or when you use the [`def`](#def) or [`set`](#set) syntax. When eyeballing a test-script,
@@ -813,7 +813,7 @@ to be heavily re-used all across your project. And yes, relative paths will wor
813813
# the following short-cut is also allowed
814814
* def someCallResult = call read('some-js-code.js')
815815
816-
# feature - you can execute all the steps defined in any other test script
816+
# re-using other scripts - you can execute all the steps defined in any other '*.feature' file
817817
# which is perfect for those common authentication or 'set up' flows
818818
* def result = call read('classpath:some-reusable-steps.feature')
819819
```
@@ -1504,8 +1504,7 @@ Feature: some feature
15041504
Background:
15051505
* configure headers = read('classpath:my-headers.js')
15061506
* def signin = call read('classpath:my-signin.feature') { username: 'john', password: 'secret' }
1507-
* def authToken = signin.authToken
1508-
* url 'http://pppdc9prd52m.corp.intuit.net/client-service/v1/'
1507+
* def authToken = signin.authToken
15091508
15101509
Scenario: some scenario
15111510
# main test steps
@@ -1551,9 +1550,8 @@ Take a look at how the [`configure headers`](#configure-headers) example uses th
15511550

15521551
Being able to define and re-use JavaScript functions is a powerful capability of Karate. For example, you can:
15531552
* call re-usable functions that take complex data as an argument and return complex data that can be stored in a variable
1554-
* move sequences of 'set up' routines out of your test-scripts so that the test can fully focus on the feature being tested
15551553
* call and interoperate with Java code if needed
1556-
* share and re-use functionality across your organization
1554+
* share and re-use test 'helper' functionality across your organization
15571555

15581556
### JavaScript Sign-In Example
15591557

0 commit comments

Comments
 (0)