Move description of substr2_ctl()

[krlmlr]

from "Details".

Perhaps substr2_ctl() should get its own help page instead?

[brodieG]

Thanks for the suggestion @krlmlr. I am very close to releasing 1.0 (release candidate is the rc branch), and in the process have been tweaking (and probably will further tweak) docs. Right now the doc in question looks like:

substr_ctl is a drop-in replacement for substr. Performance is slightly slower than substr, and more so for type = 'width'. CSI SGR sequences will be included in the substrings to reflect the format of the substring when it was embedded in the source string. substr2_ctl adds the ability to retrieve substrings based on display width in addition to the normal character width. substr2_ctl also provides the option to convert tabs to spaces with tabs_as_spaces prior to taking substrings.

So I think in reviewing I had a similar reaction to yours at some point. I did not know about the trick to create a multi-paragraph description, which is great.

I'm not sure about splitting the docs as I want people to realize substr2_ctl is there and that it does a lot more than the plain substr_ctl.

[brodieG]

v1.0 is out and includes documentation modifications that mostly address this (note, the modifications predate this PR). Thanks for noticing the issue and reaching out.