Skip to content

New feature #52

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

Open
niro4-1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

New feature #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# config-parser
A repository for parsing configuration files.

## Important Note on TOML Parsing

When loading TOML files, be aware that parse failures may occur silently. If a file contains errors, the `ConfigParser` will skip the problematic sections without raising an exception. Always validate the configuration after loading to ensure it is correct and handle any missing keys appropriately.
Expand All @@ -8,4 +11,8 @@ When loading TOML files, be aware that parse failures may occur silently. If a f
- **Validation**: Consider adding a validation step after loading to check for required keys and expected data types.
- **Debugging**: Use logging to output the loaded configuration and any skipped sections for easier debugging.

This ensures that users are aware of potential pitfalls and can handle them effectively.
This ensures that users are aware of potential pitfalls and can handle them effectively.

## New Feature

This section describes the new feature added in this branch.