Skip to content

Commit f043c8e

Browse files
committed
Adjusted docs
1 parent 07b8caf commit f043c8e

File tree

2 files changed

+18
-34
lines changed

2 files changed

+18
-34
lines changed

README.md

Lines changed: 18 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,56 +4,47 @@
44

55
```rust
66
#![feature(debug_non_exhaustive)]
7-
87
use partialdebug::non_exhaustive::PartialDebug;
98

10-
#[allow(dead_code)]
11-
struct DNA {
12-
sequence: &'static str,
13-
}
14-
159
#[derive(PartialDebug)]
1610
struct Dog {
1711
legs: usize,
1812
eyes: usize,
1913
dna: DNA,
2014
}
2115

22-
let dog = Dog {
23-
legs: 4,
24-
eyes: 2,
25-
dna: DNA {
26-
sequence: "GACCCCGATTTGA",
27-
},
28-
};
29-
assert_eq!(format!("{:?}", dog), "Dog { legs: 4, eyes: 2, .. }");
16+
assert_eq!(format!("{:?}", Dog::new()), "Dog { legs: 4, eyes: 2, .. }");
3017
```
3118

32-
## Type Info
19+
## Placeholder with Type Info
3320

3421
```rust
35-
use partialdebug::type_info::PartialDebug;
22+
use partialdebug::placeholder::PartialDebug;
3623

37-
#[allow(dead_code)]
38-
struct DNA {
39-
sequence: &'static str,
24+
#[derive(PartialDebug)]
25+
struct Dog {
26+
legs: usize,
27+
eyes: usize,
28+
dna: DNA,
4029
}
4130

31+
assert_eq!(format!("{:?}", Dog::new()), "Dog { legs: 4, eyes: 2, dna: DNA }");
32+
```
33+
34+
## Placeholder with Custom Text
35+
36+
```rust
37+
use partialdebug::placeholder::PartialDebug;
38+
4239
#[derive(PartialDebug)]
40+
#[debug_placeholder = "Unknown"]
4341
struct Dog {
4442
legs: usize,
4543
eyes: usize,
4644
dna: DNA,
4745
}
4846

49-
let dog = Dog {
50-
legs: 4,
51-
eyes: 2,
52-
dna: DNA {
53-
sequence: "GACCCCGATTTGA",
54-
},
55-
};
56-
assert_eq!(format!("{:?}", dog), "Dog { legs: 4, eyes: 2, dna: DNA }");
47+
assert_eq!(format!("{:?}", Dog::new()), "Dog { legs: 4, eyes: 2, dna: Unknown }");
5748
```
5849

5950
#### License

src/lib.rs

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
//! ```
2-
//! # #[allow(dead_code)]
3-
//! struct DNA {
4-
//! sequence: &'static str,
5-
//! }
6-
//! ```
7-
//!
81
//! # Non Exhaustive
92
//!
103
//! ```

0 commit comments

Comments
 (0)