Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nsheff authored Feb 2, 2024
1 parent e402f77 commit 060c69f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ Yacman v1 provides 2 feature upgrades:
create a new `ym` object.
2. It separates locks into read locks and write locks, to allow mutliple simultaneous readers.

The v0.9.3 transition release would has versions, really:
The `v0.9.3` transition release has 3 versions of the basic yacman object, namely:
- attmap-based version (YacAttMap)
- non-attmap-but-mostly-compatible (YAMLConfigManager)
- new future object (FutureYAMLConfigManager...), which is not-backwards-compatible.
- new future object (FutureYAMLConfigManager...), which is explicitly not backwards compatible with the attmap version.

In v1.0.0, FutureYAMLConfigManager will be renamed to YAMLConfigManager and the old stuff will be removed.
Here's how to transition your code:
Expand Down Expand Up @@ -175,4 +175,4 @@ print(ym.to_yaml())
ym = YAMLConfigManager(filepath="tests/data/full.yaml")
print(ym.to_yaml(expand=True))
```
```

0 comments on commit 060c69f

Please sign in to comment.