Skip to content

Commit

Permalink
cleanup readme/changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
jordens committed Sep 24, 2024
1 parent 86cf4c2 commit 62f3276
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
3 changes: 1 addition & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased](https://github.com/quartiq/miniconf/compare/v0.13.0...HEAD) - DATE

### Added
* Derive support for enums where all variants are newtypes has been added.
* Added `#[automatically_derived]` attributes
* Derive support for enums with newtype/unit/skipped variants

### Removed

Expand Down
8 changes: 4 additions & 4 deletions miniconf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ Fields/items that form internal nodes (non-leaf) need to implement the respectiv
Leaf fields/items need to support the respective [`serde`] trait (and the desired `serde::Serializer`/`serde::Deserializer`
backend).

Structs, arrays, and Options can then be cascaded to construct more complex trees.
Structs, enums, arrays, and Options can then be cascaded to construct more complex trees.
When using the derive macro, the behavior and tree recursion depth can be configured for each
struct field using the `#[tree(depth(Y))]` attribute.

Expand All @@ -187,11 +187,11 @@ It implements [`Keys`].

## Limitations

Access to inner fields of some types is not yet supported, e.g. enums
other than [`Option`] and enums with only newtype/unit variants.
The derive macros don't support enums with record (named fields) variants or tuple (non-newtype) variants.
These are still however usable in their atomic `serde` form as leaf nodes.

Many `std` smart pointers are not supported or handled in any special way: `Box`, `Rc`, `Arc`.
The derive macros don't handle `std`/`alloc` smart pointers ( `Box`, `Rc`, `Arc`) in any special way.
They however still be handled with accessors (`get`, `get_mut`, `validate`).

## Features

Expand Down

0 comments on commit 62f3276

Please sign in to comment.