Skip to content

Commit

Permalink
Merge #356
Browse files Browse the repository at this point in the history
356: Restructure the serde_as documentation r=jonasbb a=jonasbb

* Move the list of transformations into its own file.
* Make better use of multiple heading levels.
* Explain that conditional compilation with serde_as is currently not
  working. Explain workaround.

Closes #355

Co-authored-by: Jonas Bushart <jonas@bushart.org>
  • Loading branch information
bors[bot] and jonasbb authored Sep 4, 2021
2 parents fbb2ad6 + 9ebccbf commit b35bd81
Show file tree
Hide file tree
Showing 4 changed files with 405 additions and 363 deletions.
2 changes: 2 additions & 0 deletions src/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ This crate provides helper functions to extend and change how [`serde`] serializ
For example, you can serialize [a map as a sequence of tuples][crate::guide::serde_as#maps-to-vec-of-tuples], serialize [using the `Display` and `FromStr` traits][`DisplayFromStr`], or serialize [an empty `String` like `None`][NoneAsEmptyString].
`serde_with` covers types from the Rust Standard Library and some common crates like [`chrono`][serde_with_chrono].

[**A list of all supported transformations is available on this page.**](crate::guide::serde_as_transformations)

The crate offers four types of functionality.

## 1. A more flexible and composable replacement for the with annotation, called `serde_as` *(v1.5.0+)*
Expand Down
Loading

0 comments on commit b35bd81

Please sign in to comment.