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

doc/FAQ: Fix typos #62

Merged
merged 1 commit into from
Jan 18, 2025
Merged
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
8 changes: 4 additions & 4 deletions doc/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This is the default as it prevent any unnoticed misconfiguration that would resu
a typo to an optional field name.
To disable `strict` parsing, simply pass `StrictMode.Ignore` as the optional parameter
to either `parseConfigFile`, `parseConfigString`, or `parseConfigFileSimple` method.
To notify the user whithout triggering an error, use `StrictMode.Warn` instead.
To notify the user without triggering an error, use `StrictMode.Warn` instead.

### Make a field required

Expand Down Expand Up @@ -51,7 +51,7 @@ struct Config
}
```

Finally, as a byproduct of its functionality, using `SetInfo` implicitly make a field optional.
Finally, as a byproduct of its functionality, using `SetInfo` implicitly makes a field optional.

### Known when a field is set

Expand Down Expand Up @@ -194,7 +194,7 @@ or 87030 seconds.

### Implement complex types that are not composite types of simple types

The library recognizes three possible ways were a field of type `T`,
The library recognizes three possible ways where a field of type `T`,
where `T` is a `struct`, can be constructed:
- The `T` has a `static` `fromString` method which accepts a single argument
that is a string-like type (e.g. `scope const char[]` or just `string`),
Expand Down Expand Up @@ -279,6 +279,6 @@ this bug will need to be fixed in D-YAML.

If validation of individual fields is not enough and the section as a whole needs
to be validated, one can implement a `void validate() const` method which throws
an exception in the even of a validation failure.
an exception in the event of a validation failure.
The library will rethrow this `Exception` with the file/line information pointing
to the section itself, and not any individual field.
Loading