Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: corrected spelling #46

Merged
merged 1 commit into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/manual.typ
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
..package,
title: [Valkyrie],
date: datetime.today().display(),
abstract: [This package implements type validation, and is targetted mainly at package and template developers. The desired outcome is that it becomes easier for the programmer to quickly put a package together without spending a long time on type safety, but also to make the usage of those packages by end-users less painful by generating useful error messages.],
abstract: [This package implements type validation, and is targeted mainly at package and template developers. The desired outcome is that it becomes easier for the programmer to quickly put a package together without spending a long time on type safety, but also to make the usage of those packages by end-users less painful by generating useful error messages.],
examples-scope: (z: z),
)

Expand Down Expand Up @@ -63,7 +63,7 @@ As this package introduces several type-like objects, the Tidy style has had the

Generally, users of this package will only need to be aware of the #dtype("schema") type.

== Specifig language
== Specific language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in #link("http://www.ietf.org/rfc/rfc2119.txt", [RFC 2119]).

== Use cases
Expand All @@ -85,7 +85,7 @@ By first providing a low-level set of tools for validating primitives upon which
Validates an object against one or more schemas. *WILL* return the given object after validation if successful, or none and *MAY* throw a failed assertion error.

#argument("object", types: "any")[
Object to validate against provided schema. Object *SHOULD* statisfy the schema requirements. An error *MAY* be produced if not.
Object to validate against provided schema. Object *SHOULD* satisfy the schema requirements. An error *MAY* be produced if not.
]
#argument("schemas", types: ("array", "schema"))[
Schema against which `object` is validated. Coerced into array. *MUST* be an array of valid valkyrie schema types.
Expand Down Expand Up @@ -252,7 +252,7 @@ For the sake of brevity and owing to their consistency, the arguments that each
)

✔ Indicates that the argument is available to the user.
✱ Indicates that while the argument is availble to the user, it may be used internally or may hold a default value.
✱ Indicates that while the argument is available to the user, it may be used internally or may hold a default value.

#pagebreak()

Expand Down Expand Up @@ -321,7 +321,7 @@ For the sake of brevity and owing to their consistency, the arguments that each

#pagebreak()
#command("alignment", sarg[args], ret: "schema")[
Generates a schema that accepts only aligment objects as valid.
Generates a schema that accepts only alignment objects as valid.
]

#command("angle", sarg[args], ret: "schema")[
Expand Down
2 changes: 1 addition & 1 deletion src/coercions.typ
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
it
}

/// Tested value is forceably converted to content type
/// Tested value is forcibly converted to content type
///
/// #example[```
/// #let schema = z.content(
Expand Down