autodoc: include entire code on line in source

[sno2]

Closes #19293

I took the easy route and just add the entire line's contents. This fixes the noted issue:

However, care should be taken to make sure it does not introduce bugs if there is non-whitespace on that same line.

I am unsure if I introduced what you were warning against. Do you want

const a = 1; fn add(a: u32, b: u32) u32 {
    return a + b;
}

to render as itself, or

fn add(a: u32, b: u32) u32 {
    return a + b;
}

or

             fn add(a: u32, b: u32) u32 {
    return a + b;
}

This implementation assumes you want the first option.

[sno2]

This adds the same behavior to rendering doctests.

[nektro]

imo it should print option 2. just the decl and whitespace trimmed while preserving indentation.

[sno2]

imo it should print option 2. just the decl and whitespace trimmed while preserving indentation.

Hmm, I think we disagree on what would be the actual "Source Code." I think it would be weird to not include all of the original lines because we may make snippets show up like in the Zig guides with line numbers.

Although, the current way doesn't show any of the tokens on the last line after the terminator which would have to be changed to follow that definition.

[andrewrk]

Thanks for the patch, @sno2. This discussion has convinced me that simply including the entire line is not good enough, and the original required behavior I specified in #19293 is the required behavior.

Case 1

Input:

    fn add(a: u32, b: u32) u32 {
        return a + b;
    }

Expected Output:

fn add(a: u32, b: u32) u32 {
    return a + b;
}

Case 2

Input:

    const a = 1; fn add(a: u32, b: u32) u32 {
        return a + b;
    }

Expected Output:

fn add(a: u32, b: u32) u32 {
    return a + b;
}

Case 3

Input:

    fn add(a: u32, b: u32) u32 {
return a + b;
    }

Expected Output:

fn add(a: u32, b: u32) u32 {
return a + b;
}

Case 4

Input:

    const a = 1; fn add(a: u32, b: u32) u32 {
return a + b;
    }

Expected Output:

fn add(a: u32, b: u32) u32 {
return a + b;
}

Note that those last two cases are planned to become syntax errors:

• error for incorrectly indented code / misleading indentation #35

[nektro]

imo the existence of zig fmt's api in the stdlib should mean that with:

    const a = 1; fn add(a: u32, b: u32) u32 {
return a + b;
    }

when viewing the source of add is still rendered as:

fn add(a: u32, b: u32) u32 {
    return a + b;
}

[sno2]

If anyone else would like to work on this- be my guest. I have exams to study for until halfway through next week so I will be busy until then. Will re-open next week.