Skip to content

Commit 642f314

Browse files
committed
fix examples
1 parent 09e4111 commit 642f314

4 files changed

Lines changed: 14 additions & 10 deletions

File tree

docs/api.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,8 @@ class MyApp(argclass.Parser):
123123
app = MyApp()
124124
# Use sanitize_secrets=True to auto-remove secret env vars during parsing
125125
app.parse_args([], sanitize_secrets=True)
126-
assert str(app.api_key) == "******" # Masked in string representation
127-
assert app.api_key == "secret123" # But actual value is accessible
126+
assert repr(app.api_key) == "'******'" # Masked in repr / logs
127+
assert app.api_key == "secret123" # But actual value is accessible
128128
assert "TEST_API_KEY" not in os.environ # Already removed
129129
```
130130

@@ -316,11 +316,12 @@ app = MyApp()
316316
app.parse_args(["--log-level", "debug"])
317317
assert app.log_level == logging.DEBUG
318318

319-
app.parse_args(["--log-level", "WARNING"])
319+
app.parse_args(["--log-level", "warning"])
320320
assert app.log_level == logging.WARNING
321321
```
322322

323-
Accepts: `debug`, `info`, `warning`, `error`, `critical` (case-insensitive).
323+
Accepts the lowercase enum member names: `debug`, `info`, `warning`,
324+
`error`, `critical`, `notset`.
324325

325326
```{eval-rst}
326327
.. autoclass:: argclass.LogLevelEnum

docs/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,10 @@ class Server(argclass.Parser):
5757
port: int = 8080
5858
debug: bool = False
5959

60-
server = Server()
61-
server.parse_args()
62-
print(f"Starting server on {server.host}:{server.port}")
60+
if __name__ == "__main__":
61+
server = Server()
62+
server.parse_args()
63+
print(f"Starting server on {server.host}:{server.port}")
6364
```
6465

6566
```bash

docs/quickstart.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@ class Greeter(argclass.Parser):
1919
name: str # Required argument
2020
count: int = 1 # Optional with default
2121

22-
greeter = Greeter()
23-
greeter.parse_args()
24-
print(f"Hello, {greeter.name}!" * greeter.count)
22+
if __name__ == "__main__":
23+
greeter = Greeter()
24+
greeter.parse_args()
25+
print(f"Hello, {greeter.name}!" * greeter.count)
2526
```
2627

2728
```console

docs/security.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -447,6 +447,7 @@ Environment variables are often more secure than config files because:
447447
- Environment variables are process-scoped and not persisted
448448

449449
```python
450+
import os
450451
# Store secrets in environment, not in config.ini
451452
os.environ["API_KEY"] = "your_secret" # Set by deployment system
452453
```

0 commit comments

Comments
 (0)