Unindent for snippets

[Vampire]

Description

It would be nice if snippets would be unindented, so that the leading whitespace that is common to all lines in the snippet is removed, so it starts left-most with the first character.
This should imho even be the default behavior if it will be configurable.

Benefits

No need to cram the snippet code to beginning of line in the source file to have it nice in the docs.

Solution Idea

Just get the leading whitespace of all lines, take the shortest one and remove that from all lines.
If someone has mixed space and tab indents, it is his own fault. :-D

[facelessuser]

Related to this discussion: #1913

If we do this, it would likely only be done when injection "sections" or I guess also when specific line numbers are specified. A full file should already be dedented, and if not, that's on the user. This does run into an issue if you are injecting an indented code block, it would get dedented...but I guess if you indent the snippet syntax, then maybe it'll all work out. I'd have to verify.

This is of course if we just go the simple route and dedent all snippet partials automatically. If we have some syntax (and I don't know what that would even look like) that is meant to signify a dedent should occur, then the user would have complete control of when this does or does not happen.

The actual dedenting should be pretty easy as there are already built-in tools in Python to do so.

Anyways, stuff to think about.

[Vampire]

A full file should already be dedented, and if not, that's on the user.

👍

This does run into an issue if you are injecting an indented code block, it would get dedented...but I guess if you indent the snippet syntax, then maybe it'll all work out. I'd have to verify.

Yeah, actually having a way to intentionally indent would probably be nice if you combine different snippets or a snippet with accompanying lines.
Maybe either by indenting the scissors, or by being able to specify how far to indent as number.

[facelessuser]

Yeah, snippets can be nested too, so it is something to think about. The idea behind snippets was to just very dumbly insert a file. Feature creep is making it a bit more complicated these days, not that it's a bad thing per se. I'd need to find a way to extend the syntax in a reasonable way if we want an explicit approach.

[Vampire]

Actually I just tried, adding indent is possible by indenting the scissors

[facelessuser]

Yeah, that is what I figured. We try to respect the indentation of insertion.

[facelessuser]

For now, we are going to add an option that always dedents sectional inserts. Assuming that resolves the problem generally well, we might make it the default in the future. We'll see if that is sufficient or if there is a need for manual dedenting.

[Vampire]

I tested the dedent, works perfectly fine here, thanks.
Do you have any idea when 9.10 will be final? :-)