snipdoc 0.1.12

Code Documentation Made Simple
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

```console
$ snipdoc run --dry-run
==============================
       Snipdoc 
==============================

Overall Summary:
Folder                : [CWD]

Detailed Summary by Action Type:
Equal      : 1
Injected   : 5
Not Found  : 1
Error      : 1

Snippets to inject not found:
 - README.md, snippet id: not-found-snippet-to-inject

Found errors in the following files:
 - error-parsing.rs :  --> 2:1
  |
2 | 
  | ^---
  |
  = expected comment or tag_close

Injected In Files:
 - README.md

```

```console
$ snipdoc run --dry-run --format table
┌──────────────────┬────────────────────┬─────────────────────────────┬───────────────────────────────────┐
│ Path             │ Action             │ Snippet ID                  │                                   │
├──────────────────┼────────────────────┼─────────────────────────────┼───────────────────────────────────┤
│ README.md        │ injected           │ title                       │                                   │
├──────────────────┼────────────────────┼─────────────────────────────┼───────────────────────────────────┤
│ README.md        │ injected           │ rust-print                  │                                   │
├──────────────────┼────────────────────┼─────────────────────────────┼───────────────────────────────────┤
│ README.md        │ injected           │ create-db                   │                                   │
├──────────────────┼────────────────────┼─────────────────────────────┼───────────────────────────────────┤
│ README.md        │ equal              │ inject-snippets             │                                   │
├──────────────────┼────────────────────┼─────────────────────────────┼───────────────────────────────────┤
│ README.md        │ not-found-snippets │ not-found-snippet-to-inject │ Inject from: Code                 │
├──────────────────┼────────────────────┼─────────────────────────────┼───────────────────────────────────┤
│ README.md        │ injected           │ inject-from-yaml            │                                   │
├──────────────────┼────────────────────┼─────────────────────────────┼───────────────────────────────────┤
│ README.md        │ injected           │ inject-from-yaml            │                                   │
├──────────────────┼────────────────────┼─────────────────────────────┼───────────────────────────────────┤
│ error-parsing.rs │ error              │                             │  --> 2:1                          │
│                  │                    │                             │   |                               │
│                  │                    │                             │ 2 |                               │
│                  │                    │                             │   | ^---                          │
│                  │                    │                             │   |                               │
│                  │                    │                             │   = expected comment or tag_close │
└──────────────────┴────────────────────┴─────────────────────────────┴───────────────────────────────────┘

```