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.

Sign up for GitHub

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

Jump to bottom

Trivial: Update documentation #47

Merged
merged 3 commits into from
Jan 11, 2024
Merged

Trivial: Update documentation #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
593d343
Trivial: Update link to online documentation
Geod24 Jan 11, 2024
3581cd7
Update documentation w.r.t. strict mode
Geod24 Jan 11, 2024
d4c5fe5
Trivial: Update name in README
Geod24 Jan 11, 2024
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Config: Simple, efficient YAML -> `struct` converter
# Configy: Simple, efficient YAML -> `struct` converter

## Why (would I use this) ?

Expand Down Expand Up @@ -78,7 +78,7 @@ This demonstrate a few important properties of the config parser:

## Full documentation

The full, up-to-date API documentation can be found [here](https://bosagora.github.io/configy/).
The full, up-to-date API documentation can be found [here](https://dlang-community.github.io/configy/).
A list of example for common use cases can be found [here](doc/FAQ.md).

## Rich error reporting
Expand Down
5 changes: 3 additions & 2 deletions doc/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ not part of the `struct` definition will result in an error, indicating what fie
allowed for the section.
This is the default as it prevent any unnoticed misconfiguration that would result from
a typo to an optional field name.
To disable `strict` parsing, simply pass `false` as the optional parameter to either
`parseConfigFile`, `parseConfigString`, or `parseConfigFileSimple` method.
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.

### Make a field required

Expand Down
Loading