docstrings 0.1.1

Extract data from Markdown as used in Rust documentation strings
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

extern crate docstrings;

use docstrings::*;

#[test]
fn no_teaser() {
    assert_eq!(
        parse_md_docblock("\
# Parameters

- `foo`: Bar").unwrap_err(),
        docstrings::ParseError::NoTeaser
    );
}

#[test]
fn section_not_starting_with_list() {
    assert_eq!(
        parse_md_docblock("\
Lorem ipsum

# Parameters

Dafuq

- `foo`: Bar").unwrap_err(),
        docstrings::ParseError::UnexpectedMarkdown("Parameters".into(), "Start(Paragraph)".into())
    );
}

#[test]
fn no_ident_in_ident_list() {
    assert_eq!(
        parse_md_docblock("\
Lorem ipsum

# Parameters

- Bar
    ").unwrap_err(),
        docstrings::ParseError::NoIdent
    );
}


#[test]
fn broken_ident_list() {
    assert_eq!(
        parse_md_docblock("\
Lorem ipsum

# Parameters

- `foo`: Bar
- `other` some other thing
    ").unwrap_err(),
        docstrings::ParseError::WrongIdentDocsSeparator
    );
}