Merge pull request #7 from finreinhard/patch-1

Fix some typos
goatfryed · Oct 11, 2024 · 666988b · 666988b
2 parents 8e75eab + d2018db
commit 666988b
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # AssertBaseline
 [![Build Status](https://github.com/goatfryed/assert-baseline/actions/workflows/verify.yml/badge.svg)](https://github.com/goatfryed/assert-baseline/actions/workflows/verify.yml)
 
-Compare and approve system outputs with well-defined serialization rules based on there serialized representation.
+Compare and approve system outputs with well-defined serialization rules based on their serialized representation.
 
 ## What is AssertBaseline?
 AssertBaseline extends [AssertJ](https://github.com/assertj/assertj) to integrate format specific assertions with
@@ -37,7 +37,7 @@ For more details and other formats, see below.
 All formats are optional dependencies.
 
 #### Include in your project
-For gradle capabilities can be used
+For Gradle, capabilities can be used
 ```groovy
 implementation("com.github.goatfryed:assert-baseline:{version}") {
   capabilities {
@@ -70,7 +70,7 @@ assertThatJson(jsonString)
     .isEqualToBaseline("specs/my.baseline.json");
 ```
 `formatAssertion.isEqualToBaseline(pathToBaseline)` executes the baseline assertion.
-The parameter pathToBaseline is relative to the resource context. See more on convention below
+The parameter pathToBaseline is relative to the resource context. See more on conventions below
 
 `formatAssertion.using{Format}Comparator(...)` provides ways to control the comparison
 in a format specific way exposing options of the reused libraries.

diff --git a/docs/assert-json-baseline.md b/docs/assert-json-baseline.md
@@ -1,5 +1,5 @@
 # JSON Assertions
-Json support is added through [json-unit](https://github.com/lukas-krecan/JsonUnit).
+JSON support is added through [json-unit](https://github.com/lukas-krecan/JsonUnit).
 
 ```java
 import static com.github.goatfryed.assert_baseline.Assertions.assertThatJson;
@@ -34,7 +34,7 @@ For maven
 </dependencies>
 ````
 
-## Tips & Recipies
+## Tips & Recipes
 ### Ignore auto-generated, volatile fields
 ```java
 assertThatJson(jsonString)
@@ -44,4 +44,4 @@ assertThatJson(jsonString)
             "$.event.timestamp"
         )
     ).isEqualToBaseline(pathToBaseline);
-```
+```
diff --git a/docs/assert-text-baseline.md b/docs/assert-text-baseline.md
@@ -1,8 +1,8 @@
 # Text Assertions
-String assertions require no additional dependency and use simply assertJ.
+String assertions require no additional dependency and use simply AssertJ.
 
 ```java
-import static com.github.goatfryed.assert_baseline.Assertions.assertThatJson;
+import static com.github.goatfryed.assert_baseline.Assertions.assertThatText;
 
 assertThatText(yourString)
     .isEqualToBaseline("src/test/resources/specs/my.baseline.txt");
@@ -25,5 +25,5 @@ For maven
 </dependencies>
 ````
 
-## Tips & Recipies
-`usingTextComparator` is simply an alias for `usingComparator` of assertJ on String subjects
+## Tips & Recipes
+`usingTextComparator` is simply an alias for `usingComparator` of AssertJ on String subjects
diff --git a/docs/assert-xml-baseline.md b/docs/assert-xml-baseline.md
@@ -34,7 +34,7 @@ For maven
 </dependencies>
 ````
 
-## Tips & Recipies
+## Tips & Recipes
 Ignore auto-generated, volatile fields
 ```java
 import static com.github.goatfryed.assert_baseline.xml.XmlDiffConfiguration.ignoringXPath;
@@ -47,4 +47,4 @@ assertThatXml(xmlContent)
             ::test
         )
     ).isEqualToBaseline(pathToBaseline);
-```
+```
diff --git a/docs/convention-and-configuration.md b/docs/convention-and-configuration.md
@@ -32,16 +32,16 @@ Usually, you want to do so by extending
 public class MyBaselineConvention extends AbstractConvention {
 
     @Override
-    public void String resolveActualPath(String requestedBaselinePath) {
+    public String resolveActualPath(String requestedBaselinePath) {
         return "src/test/resources/actual/" + requestedBaselinePath;
     }
 
     @Override
-    public void String resolveActualPath(String requestedBaselinePath) {
+    public String resolveActualPath(String requestedBaselinePath) {
         return "src/test/resources/expected/" + requestedBaselinePath;
     }
 }
 ```
 This would allow you to call `assertThatJson(event).isEqualToBaseline(event.json)`
 and have the actual file stored as `src/test/resources/actual/event.json` and compared with
-`src/test/resources/expected/event.json`
+`src/test/resources/expected/event.json`
diff --git a/docs/project-scope.md b/docs/project-scope.md
@@ -8,7 +8,7 @@ what this projects aims to be.
 Note that project does not necessarily mean one single library artifact.
 
 ## Goals
-- Provide an assertj integration for baseline testing and follow it's general feel
+- Provide an assertj integration for baseline testing and follow its general feel
 - Provide easy integration with common format assertion libraries
 - Provide sensible defaults that work for most projects and extensibility to overwrite all
 - Handle basic storage aspects (e.g. file system handling, path management)