snakedown 0.3.0

This is a snakedown. Hand over your docs, nice and clean, and nobody gets confused.
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

use crate::indexing::object_ref::ObjectRef;

use super::class::ClassDocumentation;
use super::function::FunctionDocumentation;
use super::module::ModuleDocumentation;

#[derive(Debug)]
pub enum ObjectDocumentation {
    Module(ModuleDocumentation),
    Class(ClassDocumentation),
    Function(FunctionDocumentation),
}

impl ObjectDocumentation {
    pub fn docstring(&self) -> Option<String> {
        match self {
            ObjectDocumentation::Module(module_documentation) => {
                module_documentation.docstring.clone()
            }
            ObjectDocumentation::Class(class_documentation) => {
                class_documentation.docstring.clone()
            }
            ObjectDocumentation::Function(function_documentation) => {
                function_documentation.docstring.clone()
            }
        }
    }
    pub fn extract_used_references(&self) -> Option<(String, Vec<ObjectRef>)> {
        match self {
            ObjectDocumentation::Module(module_documentation) => {
                module_documentation.extract_used_references()
            }
            ObjectDocumentation::Class(class_documentation) => {
                class_documentation.extract_used_references()
            }
            ObjectDocumentation::Function(function_documentation) => {
                function_documentation.extract_used_references()
            }
        }
    }

    pub(crate) fn replace_docstring(&mut self, object_docstring: Option<String>) {
        match self {
            ObjectDocumentation::Module(module_documentation) => {
                module_documentation.docstring = object_docstring;
            }
            ObjectDocumentation::Class(class_documentation) => {
                class_documentation.docstring = object_docstring;
            }
            ObjectDocumentation::Function(function_documentation) => {
                function_documentation.docstring = object_docstring;
            }
        }
    }
}