Inconsistent documentation for margin masks

[Mitchell]

Hi Neil,

The documentation for margins says "Margin 2 is set to display the folding symbols, but is given a width of 0, so it is hidden.” However, the code for margin 2 says "ms[2] = MarginStyle(MarginType::Symbol);” I’ve confirmed that by default, Scintilla does not show fold symbols in the second margin.

Which is the desired behavior?

Cheers,
Mitchell

[Mitchell]

Hi,

> On Apr 16, 2025, at 7:12 PM, Mitchell <co...@foicica.com> wrote:
>
> Hi Neil,
>
> The documentation for margins says "Margin 2 is set to display the folding symbols, but is given a width of 0, so it is hidden.” However, the code for margin 2 says "ms[2] = MarginStyle(MarginType::Symbol);” I’ve confirmed that by default, Scintilla does not show fold symbols in the second margin.

Sorry, I meant the third margin, the one at index 2, does not show fold symbols by default.

Cheers,
Mitchell

[Neil Hodgson]

Looking through history, it appears that the documentation describes aspects of the implementation that were true at different points. Then the margin was hidden by default and its mask set to 0 instead of all the fold symbols.

It would likely be better behaviour for new projects to restore the fold symbol mask for margin 2 but that may cause unwanted change to existing applications. Probably best to err on the side of caution by continuing the current behaviour and changing the documentation to omit 'folding symbols'. so:

"Margin 2 is a symbol margin that is given a width of 0, so it is hidden."

Neil

[Mitchell]

Hi Neil,

That’s fine. My application will continue to define a fold symbol mask for margin 2 then.

Cheers,
Mitchell