Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

VimHelp uses its own option to control the wrap column of the text rather than a generic one #551

Open
Fat-Zer opened this issue Jan 28, 2025 · 3 comments

Comments

@Fat-Zer
Copy link
Contributor

Fat-Zer commented Jan 28, 2025

As for now vimhelp provides its own option to wrap the text textwidth. I would suggest to use the generic TransTractor's one wrapcol instead (which is controlled by -w/--width option of the scripts).

As for now the generic default is 76, but the VimHelp's is 78. Is this correct?

@gemmaro, any objections?

@Fat-Zer
Copy link
Contributor Author

Fat-Zer commented Jan 28, 2025

Also there is codeblock splitting into several paragraphes. Is it actually desirable?

@gemmaro
Copy link
Contributor

gemmaro commented Jan 28, 2025

Hello @Fat-Zer,

As for now vimhelp provides its own option to wrap the text textwidth. I would suggest to use the generic TransTractor's one wrapcol instead (which is controlled by -w/--width option of the scripts).

Good catch! That option is indeed more suitable for this purpose. Since the VimHelp format support hasn't been released yet, removing the textwidth option seems reasonable.

As for now the generic default is 76, but the VimHelp's is 78. Is this correct?

Yes, I'd like to set the default value to 78 for the VimHelp format, since the official Vim help files use this value (e.g. https://github.com/vim/vim/blob/04cc8975930b7b2c5d6753d3eddf57dab2816518/runtime/doc/if_perl.txt#L307).

Also there is codeblock splitting into several paragraphes. Is it actually desirable?

I prefer this approach since it results in smaller messages in the PO file. However, it might be beneficial to have an option to change this behavior if combined code block messages are preferred.

@gemmaro
Copy link
Contributor

gemmaro commented Feb 14, 2025

This is off-topic to the issue title, but I've noticed code blocks can also start with >vim (followed by a line end). Currently, only > is supported (ref. example).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants