Skip to content

Commit cdc7dea

Browse files
committed
Update documentation.
1 parent 49ce5eb commit cdc7dea

File tree

6 files changed

+13
-23
lines changed

6 files changed

+13
-23
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ In the above example:
9696
Inside the lambda you can define test cases.
9797
The `Solution` functions will only be invoked if the relevant part DSL is used.
9898
If you have not yet implemented the second part, or it doesn't exist
99-
_(e.g.: Every year, part two of the last day just requires collecting all other 49 stars)_,
99+
_(e.g.: Every year, part two of the last day just requires collecting all other stars)_,
100100
then you may simply omit it.
101101
5. To define a test case, use the `shouldOutput` function.
102102
Each usage will define another test case.

docs/topics/debugging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ class Y9999D01 : AdventSpec<Y9999D01>({
3333
solution.partOne(input)
3434
}
3535

36-
// Every other declarations are effectively ignored ...
36+
// Any other declarations are effectively ignored ...
3737
})
3838
```
3939

docs/topics/multiple-solutions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Multiple Solutions
22

33
You sometimes might want to implement multiple solutions to the same puzzle.
4-
For example to compare imperative vs. functional code styles, or test different data structures, or algorithms.
4+
For example, to compare imperative vs. functional code styles, or test different data structures and algorithms.
55

66
Since all these different implementations solve the same puzzle, they should have identical test cases.
77
The `AdventSpec` is designed to test a single `Solution` at a time.

docs/topics/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ In the above example:
121121
Inside the lambda you can define test cases.
122122
The `Solution` functions will only be invoked if the relevant part DSL is used.
123123
If you have not yet implemented the second part, or it doesn't exist
124-
_(e.g.: Every year, part two of the last day just requires collecting all other 49 stars)_,
124+
_(e.g.: Every year, part two of the last day just requires collecting all other stars)_,
125125
then you may simply omit it.
126126
5. To define a test case, use the `shouldOutput` function.
127127
Each usage will define another test case.

docs/topics/project-extension.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ It offers the following features:
2525

2626
`AdventSpec`s will always execute in chronological order.
2727
All other specs will run before them, in the order they were discovered.
28-
Note that this overrides Kotest's own [spec ordering`](https://kotest.io/docs/framework/spec-ordering.html).
28+
Note that this overrides Kotest's own [spec ordering](https://kotest.io/docs/framework/spec-ordering.html).
2929

3030
## Registering The Extension
3131

@@ -40,17 +40,7 @@ object TestConfig : AbstractProjectConfig() {
4040
}
4141
```
4242

43-
To make Kotest use this configuration, you must register it in the
44-
[`kotest.properties`](https://kotest.io/docs/intellij/intellij-properties.html#specifying-the-properties-filename)
45-
file in your `src/test/resources`:
46-
47-
```properties
48-
kotest.framework.config.fqn=my.aoc.TestConfig
49-
kotest.framework.classpath.scanning.autoscan.disable=true
50-
kotest.framework.classpath.scanning.config.disable=true
51-
```
52-
53-
You should also register the fqn as a system property for Gradle:
43+
To make Kotest use this configuration, you must register the FQN as a system property for Gradle:
5444

5545
```kotlin
5646
tasks.test {

docs/topics/workflow.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ projectDir
2929
│ └── aockt
3030
│ └── y2015
3131
│ └── d01
32-
── input.txt
33-
── solution_part1.txt
32+
── input.txt
33+
── solution_part1.txt
3434
│ └── solution_part2.txt
3535
├── solutions
3636
│ └── aockt
@@ -80,7 +80,7 @@ projectDir
8080
- Each day has a directory as a base path: `/aockt/y[year]/d[twoDigitDay]`
8181
- In that directory, the input is in the `input.txt` file.
8282
- The solutions use `solution_part1.txt` and `solution_part2.txt`.
83-
They are added in as discovered.
83+
They are added in gradually, as discovered.
8484

8585
> ***DO NOT Commit Puzzle Inputs!***
8686
>
@@ -121,7 +121,7 @@ object Y2015D01 : Solution
121121

122122
> Your class _must have_ a zero-arg constructor.
123123
124-
Following the same logic, create its `tests` analog:
124+
Following the same logic, create its `tests` counterpart:
125125

126126
```kotlin
127127
package aockt.y2015
@@ -155,7 +155,7 @@ class Y2015D01Test : AdventSpec<Y2015D01>({
155155
})
156156
```
157157

158-
Like many other puzzles, this day provides you with example inputs and outputs to test your solution.
158+
Like many other puzzles, this day provides you with example inputs and outputs to test your solution with.
159159

160160
If that is the case, you can define them in a lambda.
161161
The syntax is `"string" shouldOutput "output"`, the output can be a string, or a number, it will be checked against its
@@ -188,7 +188,7 @@ Your first run should look like this:
188188

189189
Each example has its own test, and since you added your input, it also tests against that.
190190

191-
> If you're not interested in running on our input until validating the examples, you can
191+
> If you're not interested in running against your input until validating the examples first, you can
192192
> [ignore your input](test-config.md#executionmode) by setting:
193193
>
194194
> `partOne(executionMode = ExecMode.ExamplesOnly)`
@@ -251,7 +251,7 @@ Go back to the website and submit it.
251251

252252
**Congratulations on collecting the first star!** ⭐
253253

254-
If not, try to look at what's special in your input, or hunt down any bugs.
254+
If not, try to look at what's special in your input, or [hunt down bugs](debugging.md).
255255
256256
Once you have verified the right answer, paste it in `inputs/aockt/y2015/d01/solution_part1.txt`.
257257
Now, when you run the test, your code will be tested against the known answer:

0 commit comments

Comments
 (0)