Skip to content

Commit

Permalink
More formatting of doc tests and example code
Browse files Browse the repository at this point in the history
  • Loading branch information
dtolnay committed Jul 6, 2023
1 parent 1920b69 commit fa0312a
Show file tree
Hide file tree
Showing 11 changed files with 30 additions and 36 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ serde_json = "1.0"
<p></p>

```rust
use serde::{Serialize, Deserialize};
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Debug)]
struct Point {
Expand Down
2 changes: 1 addition & 1 deletion crates-io.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You may be looking for:
## Serde in action

```rust
use serde::{Serialize, Deserialize};
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Debug)]
struct Point {
Expand Down
5 changes: 2 additions & 3 deletions serde/src/de/ignored_any.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,11 @@ use de::{
/// gets deserialized.
///
/// ```edition2021
/// use std::fmt;
/// use std::marker::PhantomData;
///
/// use serde::de::{
/// self, Deserialize, DeserializeSeed, Deserializer, IgnoredAny, SeqAccess, Visitor,
/// };
/// use std::fmt;
/// use std::marker::PhantomData;
///
/// /// A seed that can be used to deserialize only the `n`th element of a sequence
/// /// while efficiently discarding elements of any type before or after index `n`.
Expand Down
9 changes: 3 additions & 6 deletions serde/src/de/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -433,9 +433,8 @@ impl<'a> fmt::Display for Unexpected<'a> {
/// (`&self`) is an implementation of this trait.
///
/// ```edition2021
/// # use std::fmt;
/// #
/// # use serde::de::{self, Unexpected, Visitor};
/// # use std::fmt;
/// #
/// # struct Example;
/// #
Expand Down Expand Up @@ -667,11 +666,10 @@ impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de> {}
/// trait.
///
/// ```edition2021
/// use serde::de::{Deserialize, DeserializeSeed, Deserializer, SeqAccess, Visitor};
/// use std::fmt;
/// use std::marker::PhantomData;
///
/// use serde::de::{Deserialize, DeserializeSeed, Deserializer, SeqAccess, Visitor};
///
/// // A DeserializeSeed implementation that uses stateful deserialization to
/// // append array elements onto the end of an existing vector. The preexisting
/// // state ("seed") in this case is the Vec<T>. The `deserialize` method of
Expand Down Expand Up @@ -1253,9 +1251,8 @@ pub trait Deserializer<'de>: Sized {
/// # Example
///
/// ```edition2021
/// # use std::fmt;
/// #
/// # use serde::de::{self, Unexpected, Visitor};
/// # use std::fmt;
/// #
/// /// A visitor that deserializes a long string - a string containing at least
/// /// some minimum number of bytes.
Expand Down
3 changes: 1 addition & 2 deletions serde/src/macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,9 @@
/// specified explicitly if necessary.
///
/// ```edition2021
/// # use std::marker::PhantomData;
/// #
/// # use serde::forward_to_deserialize_any;
/// # use serde::de::{value, Deserializer, Visitor};
/// # use std::marker::PhantomData;
/// #
/// # struct MyDeserializer<V>(PhantomData<V>);
/// #
Expand Down
2 changes: 1 addition & 1 deletion serde_derive/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//! This crate provides Serde's two derive macros.
//!
//! ```edition2021
//! # use serde_derive::{Serialize, Deserialize};
//! # use serde_derive::{Deserialize, Serialize};
//! #
//! #[derive(Serialize, Deserialize)]
//! # struct S;
Expand Down
19 changes: 9 additions & 10 deletions serde_test/src/assert.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use std::fmt::Debug;
/// Runs both `assert_ser_tokens` and `assert_de_tokens`.
///
/// ```edition2021
/// # use serde_derive::{Serialize, Deserialize};
/// # use serde_derive::{Deserialize, Serialize};
/// # use serde_test::{assert_tokens, Token};
/// #
/// #[derive(Serialize, Deserialize, PartialEq, Debug)]
Expand Down Expand Up @@ -43,7 +43,7 @@ where
/// Asserts that `value` serializes to the given `tokens`.
///
/// ```edition2021
/// # use serde_derive::{Serialize, Deserialize};
/// # use serde_derive::{Deserialize, Serialize};
/// # use serde_test::{assert_ser_tokens, Token};
/// #
/// #[derive(Serialize, Deserialize, PartialEq, Debug)]
Expand Down Expand Up @@ -85,11 +85,10 @@ where
/// `error`.
///
/// ```edition2021
/// use std::sync::{Arc, Mutex};
/// use std::thread;
///
/// use serde_derive::Serialize;
/// use serde_test::{assert_ser_tokens_error, Token};
/// use std::sync::{Arc, Mutex};
/// use std::thread;
///
/// #[derive(Serialize)]
/// struct Example {
Expand All @@ -102,16 +101,16 @@ where
/// };
/// let lock = example.lock.clone();
///
/// let _ = thread::spawn(move || {
/// let thread = thread::spawn(move || {
/// // This thread will acquire the mutex first, unwrapping the result
/// // of `lock` because the lock has not been poisoned.
/// let _guard = lock.lock().unwrap();
///
/// // This panic while holding the lock (`_guard` is in scope) will
/// // poison the mutex.
/// panic!()
/// })
/// .join();
/// });
/// thread.join();
///
/// let expected = &[
/// Token::Struct {
Expand Down Expand Up @@ -143,7 +142,7 @@ where
/// Asserts that the given `tokens` deserialize into `value`.
///
/// ```edition2021
/// # use serde_derive::{Serialize, Deserialize};
/// # use serde_derive::{Deserialize, Serialize};
/// # use serde_test::{assert_de_tokens, Token};
/// #
/// #[derive(Serialize, Deserialize, PartialEq, Debug)]
Expand Down Expand Up @@ -200,7 +199,7 @@ where
/// Asserts that the given `tokens` yield `error` when deserializing.
///
/// ```edition2021
/// # use serde_derive::{Serialize, Deserialize};
/// # use serde_derive::{Deserialize, Serialize};
/// # use serde_test::{assert_de_tokens_error, Token};
/// #
/// #[derive(Serialize, Deserialize, PartialEq, Debug)]
Expand Down
18 changes: 9 additions & 9 deletions serde_test/src/token.rs
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ pub enum Token {
/// A serialized unit struct of the given name.
///
/// ```edition2021
/// # use serde_derive::{Serialize, Deserialize};
/// # use serde_derive::{Deserialize, Serialize};
/// # use serde_test::{assert_tokens, Token};
/// #
/// # fn main() {
Expand All @@ -198,7 +198,7 @@ pub enum Token {
/// A unit variant of an enum.
///
/// ```edition2021
/// # use serde_derive::{Serialize, Deserialize};
/// # use serde_derive::{Deserialize, Serialize};
/// # use serde_test::{assert_tokens, Token};
/// #
/// # fn main() {
Expand Down Expand Up @@ -227,7 +227,7 @@ pub enum Token {
/// After this header is the value contained in the newtype struct.
///
/// ```edition2021
/// # use serde_derive::{Serialize, Deserialize};
/// # use serde_derive::{Deserialize, Serialize};
/// # use serde_test::{assert_tokens, Token};
/// #
/// # fn main() {
Expand All @@ -248,7 +248,7 @@ pub enum Token {
/// After this header is the value contained in the newtype variant.
///
/// ```edition2021
/// # use serde_derive::{Serialize, Deserialize};
/// # use serde_derive::{Deserialize, Serialize};
/// # use serde_test::{assert_tokens, Token};
/// #
/// # fn main() {
Expand Down Expand Up @@ -329,7 +329,7 @@ pub enum Token {
/// `TupleStructEnd`.
///
/// ```edition2021
/// # use serde_derive::{Serialize, Deserialize};
/// # use serde_derive::{Deserialize, Serialize};
/// # use serde_test::{assert_tokens, Token};
/// #
/// # fn main() {
Expand Down Expand Up @@ -359,7 +359,7 @@ pub enum Token {
/// `TupleVariantEnd`.
///
/// ```edition2021
/// # use serde_derive::{Serialize, Deserialize};
/// # use serde_derive::{Deserialize, Serialize};
/// # use serde_test::{assert_tokens, Token};
/// #
/// # fn main() {
Expand Down Expand Up @@ -428,7 +428,7 @@ pub enum Token {
/// After this header are the fields of the struct, followed by `StructEnd`.
///
/// ```edition2021
/// # use serde_derive::{Serialize, Deserialize};
/// # use serde_derive::{Deserialize, Serialize};
/// # use serde_test::{assert_tokens, Token};
/// #
/// # fn main() {
Expand Down Expand Up @@ -463,7 +463,7 @@ pub enum Token {
/// `StructVariantEnd`.
///
/// ```edition2021
/// # use serde_derive::{Serialize, Deserialize};
/// # use serde_derive::{Deserialize, Serialize};
/// # use serde_test::{assert_tokens, Token};
/// #
/// # fn main() {
Expand Down Expand Up @@ -500,7 +500,7 @@ pub enum Token {
/// The header to an enum of the given name.
///
/// ```edition2021
/// # use serde_derive::{Serialize, Deserialize};
/// # use serde_derive::{Deserialize, Serialize};
/// # use serde_test::{assert_tokens, Token};
/// #
/// # fn main() {
Expand Down
2 changes: 1 addition & 1 deletion test_suite/no_std/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ fn panic(_info: &core::panic::PanicInfo) -> ! {

//////////////////////////////////////////////////////////////////////////////

use serde::{Serialize, Deserialize};
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize)]
struct Unit;
Expand Down
2 changes: 1 addition & 1 deletion test_suite/tests/ui/remote/missing_field.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use serde_derive::{Serialize, Deserialize};
use serde_derive::{Deserialize, Serialize};

mod remote {
pub struct S {
Expand Down
2 changes: 1 addition & 1 deletion test_suite/tests/ui/remote/unknown_field.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use serde_derive::{Serialize, Deserialize};
use serde_derive::{Deserialize, Serialize};

mod remote {
pub struct S {
Expand Down

0 comments on commit fa0312a

Please sign in to comment.