Expand documentation

[brendanzab]

Expand documentation

[brendanzab]

Yeah, it's a bit confusing! You first need a CodeMap, and then a FileMap, and then get indices from there. I've been thinking of ways to make the simple cases easier for some time now seeing as it keeps tripping people up. 😬

Would definitely appreciate some help with the docs! You might also be interested in #52 which talks about some simplifications that we might be able to do as well. I'm also available to chat on https://gitter.im/codespan-rs/Lobby as well.

[segeljakt]

I get how it works now, the example could maybe be simplified to something like:

use {
    codespan::{ByteIndex, ByteSpan, CodeMap},
    codespan_reporting::{
        emit,
        termcolor::{ColorChoice, StandardStream},
        Diagnostic, Label, Severity,
    },
};

const SOURCE: &'static str = "fn main() { 1 + '3' }";

fn main() {
    let mut code_map = CodeMap::new();
    code_map.add_filemap("virtual_file".into(), SOURCE.to_string());

    let error = Diagnostic::new(Severity::Error, "Unexpected type in `+` application")
        .with_label(
            Label::new_primary(ByteSpan::new(ByteIndex(13), ByteIndex(19)))
                .with_message("Expected integer but got char"),
        )
        .with_code("E0001");

    let writer = StandardStream::stderr(ColorChoice::Auto);
    emit(&mut writer.lock(), &code_map, &error).unwrap();
    println!();
}

[brendanzab]

Codespan is a lot less tricky to understand now that we don't use global byte indices. If you have any other problems feel free to make some more issues!

[segeljakt]

Awesome thanks 😊