Merge pull request #2723 from jeremykohn/api-typos

hueniverse · web-flow · commit 7e5aebfd22ab · 2022-01-12T13:50:16.000-08:00
Fix typos in API.md ('Names links' -&gt; 'Named links', 'unknownMisees' -&gt; 'unknownMisses')
diff --git a/API.md b/API.md
@@ -1999,7 +1999,7 @@ Supports the methods of the [`any()`](#any) type.
 
 When links are combined with `any.when()` rules, the rules are applied after the link is resolved to the linked schema.
 
-Names links are recommended for most use cases as they are easy to reason and understand, and when mistakes are made, they simply error with invalid link message. Relative links are often hard to follow, especially when they are nested in array or alternatives rules. Absolute links are useful only when the schema is never reused inside another schema as the root is the run-time root of the schema being validated, not the current schema root.
+Named links are recommended for most use cases as they are easy to reason and understand, and when mistakes are made, they simply error with invalid link message. Relative links are often hard to follow, especially when they are nested in array or alternatives rules. Absolute links are useful only when the schema is never reused inside another schema as the root is the run-time root of the schema being validated, not the current schema root.
 
 Note that named links must be found in a direct ancestor of the link. The names are searched by iterating over the chain of schemas from the current schema to the root. To reach an uncle or cousin, you must use the name of a common ancestor such as a grandparent and then walk down the tree.
 
@@ -3582,7 +3582,7 @@ Additional local context properties:
 ```ts
 {
     knownMisses: Array<string>, // Labels of all the missing values
-    unknownMisees: number // Count of missing values that didn't have a label
+    unknownMisses: number // Count of missing values that didn't have a label
 }
 ```
 
@@ -3604,7 +3604,7 @@ Some values were expected to be present in the array and are missing. This error
 Additional local context properties:
 ```ts
 {
-    unknownMisees: number // Count of missing values that didn't have a label
+    unknownMisses: number // Count of missing values that didn't have a label
 }
 ```
 

Original file line number	Diff line number	Diff line change
@@ -1999,7 +1999,7 @@ Supports the methods of the [`any()`](#any) type.
`1999`	`1999`
`2000`	`2000`	When links are combined with `any.when()` rules, the rules are applied after the link is resolved to the linked schema.
`2001`	`2001`
`2002`		`-Names links are recommended for most use cases as they are easy to reason and understand, and when mistakes are made, they simply error with invalid link message. Relative links are often hard to follow, especially when they are nested in array or alternatives rules. Absolute links are useful only when the schema is never reused inside another schema as the root is the run-time root of the schema being validated, not the current schema root.`
	`2002`	`+Named links are recommended for most use cases as they are easy to reason and understand, and when mistakes are made, they simply error with invalid link message. Relative links are often hard to follow, especially when they are nested in array or alternatives rules. Absolute links are useful only when the schema is never reused inside another schema as the root is the run-time root of the schema being validated, not the current schema root.`
`2003`	`2003`
`2004`	`2004`	`Note that named links must be found in a direct ancestor of the link. The names are searched by iterating over the chain of schemas from the current schema to the root. To reach an uncle or cousin, you must use the name of a common ancestor such as a grandparent and then walk down the tree.`
`2005`	`2005`
`@@ -3582,7 +3582,7 @@ Additional local context properties:`
`3582`	`3582`	```ts
`3583`	`3583`	`{`
`3584`	`3584`	`knownMisses: Array<string>, // Labels of all the missing values`
`3585`		`- unknownMisees: number // Count of missing values that didn't have a label`
	`3585`	`+ unknownMisses: number // Count of missing values that didn't have a label`
`3586`	`3586`	`}`
`3587`	`3587`	```
`3588`	`3588`
`@@ -3604,7 +3604,7 @@ Some values were expected to be present in the array and are missing. This error`
`3604`	`3604`	`Additional local context properties:`
`3605`	`3605`	```ts
`3606`	`3606`	`{`
`3607`		`- unknownMisees: number // Count of missing values that didn't have a label`
	`3607`	`+ unknownMisses: number // Count of missing values that didn't have a label`
`3608`	`3608`	`}`
`3609`	`3609`	```
`3610`	`3610`