Skip to content

Fix docs: remove non-existent Parser/set_parser references #53

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

Merged
HEROgold merged 2 commits into from
Mar 2, 2026
Merged

Fix docs: remove non-existent Parser/set_parser references #53

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65800d5
Initial plan
Copilot Mar 2, 2026
f78736d
Fix documentation: remove non-existent Parser/set_parser references
Copilot Mar 2, 2026
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
13 changes: 3 additions & 10 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,24 +175,17 @@ The `with_setting` approach is more type-safe as it references an actual descrip

### Required Initialization

Always initialize Config with a file path before use. The Parser facade automatically detects and uses the appropriate adapter based on file extension:
Always initialize Config with a file path before use. The parser is auto-detected based on file extension:

```python
from pathlib import Path
from confkit import Config

# Simplified approach - parser is auto-detected based on file extension
# Parser is auto-detected based on file extension
Config.set_file(Path("config.ini")) # Uses IniParser
Config.set_file(Path("config.json")) # Uses MsgspecParser
Config.set_file(Path("config.yaml")) # Uses MsgspecParser
Config.set_file(Path("config.toml")) # Uses MsgspecParser
Config.set_file(Path(".env")) # Uses EnvParser

# Option 2: Explicitly set parser (not recommended unless absolutely required)
from confkit.ext.parsers import Parser
parser = Parser(Path("config.ini"))
Config.set_parser(parser)
Config.set_file(Path("config.ini"))
```

### Supported File Formats
Expand All @@ -201,7 +194,7 @@ Config.set_file(Path("config.ini"))
- **JSON files** (`.json`): Uses `MsgspecParser`, requires `msgspec` extra
- **YAML files** (`.yaml`, `.yml`): Uses `MsgspecParser`, requires `msgspec` extra
- **TOML files** (`.toml`): Uses `MsgspecParser`, requires `msgspec` extra
- **Environment files** (`.env`): Uses `EnvParser`, no sections (flat key-value pairs)
- **Environment files** (`.env`): Uses `EnvParser`, no sections (flat key-value pairs) — not auto-detected by `set_file`

### List Type Handling

Expand Down