[PATCH] runtime(rst): Add support for rst_minlines variable

[Dragan Simic]

Following the approach used in other syntax definitions, add support for
defining the "syntax sync minlines=..." values for rst files in the users'
~/.vimrc files, to allow the users to adjust that value in case syntax
highlighting stops working for some of the files they edit.

Signed-off-by: Dragan Simic <dsi...@manjaro.org>
---

Notes:
It seems that patches like this one should be submitted through the
respective GitHub project pages. Though, I'm unable to use GitHub,
so I'd appreciate if this patch could be picked up from the vim-dev
mailing list by the respective project maintainer.

runtime/syntax/rst.vim | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/runtime/syntax/rst.vim b/runtime/syntax/rst.vim
index a90c90be21a2..b4f50f36f4a3 100644
--- a/runtime/syntax/rst.vim
+++ b/runtime/syntax/rst.vim
@@ -3,7 +3,7 @@
" Maintainer: Marshall Ward <marsha...@gmail.com>
" Previous Maintainer: Nikolai Weibull <n...@bitwi.se>
" Website: https://github.com/marshallward/vim-restructuredtext
-" Latest Revision: 2020-03-31
+" Latest Revision: 2025-03-06

if exists("b:current_syntax")
finish
@@ -246,8 +246,7 @@ endfor
" Enable top level spell checking
syntax spell toplevel

-" TODO: Use better syncing.
-syn sync minlines=50 linebreaks=2
+exe "syn sync minlines=" . get(g:, 'rst_minlines', 50) . " linebreaks=2"

hi def link rstTodo Todo
hi def link rstComment Comment

[Christian Brabandt]

On Thu, 06 Mar 2025, 'Dragan Simic' via vim_dev wrote:

> Following the approach used in other syntax definitions, add support for
> defining the "syntax sync minlines=..." values for rst files in the users'
> ~/.vimrc files, to allow the users to adjust that value in case syntax
> highlighting stops working for some of the files they edit.

Thanks, I redirected this to
https://github.com/marshallward/vim-restructuredtext/issues/76

I am not sure if that repo is still actively maintained, so if there is
no activity within the next month, feel free to nudge me to include this
directly into Vim.

Thanks,
Chris
Mit freundlichen Grüßen
Christian
--
Nothing is so firmly believed as that which we least know.
-- Michel de Montaigne

[Dragan Simic]

Hello Christian,

On 2025-03-06 22:45, Christian Brabandt wrote:
> On Thu, 06 Mar 2025, 'Dragan Simic' via vim_dev wrote:
>
>> Following the approach used in other syntax definitions, add support
>> for
>> defining the "syntax sync minlines=..." values for rst files in the
>> users'
>> ~/.vimrc files, to allow the users to adjust that value in case syntax
>> highlighting stops working for some of the files they edit.
>
> Thanks, I redirected this to
> https://github.com/marshallward/vim-restructuredtext/issues/76
>
> I am not sure if that repo is still actively maintained, so if there is
> no activity within the next month, feel free to nudge me to include
> this
> directly into Vim.

Great, thanks! I'll keep an eye on it, and will let you know.

[Maxim Kim]

It would also need an entry in a doc, right? Like in :h g:markdown_minlines

[Christian Brabandt]

On Thu, 06 Mar 2025, Maxim Kim wrote:

> It would also need an entry in a doc, right? Like in :h g:markdown_minlines

Yes it would and I mentioned it in the PR I created. Unfortunately, the
upstream repo doesn't contain docs, so we will have to add it once it is
synced back with the Vim repo.

Thanks,
Christian
--
It was one time too many
One word too few
It was all too much for me and you
There was one way to go
Nothing more we could do
One time too many
One word too few
-- Meredith Tanner

[Dragan Simic]

Please see the attached patch as an attempt to provide a short addition
to the Vim documentation, which describes the rst_minlines variable.
I'm
sorry for not including that already in my first patch.

[Marshall Ward]

Dragan, I have added your patch to the development PR.  Thanks very much for noting this issue.

Several outstanding highlight issues have discouraged me from sending any updates - including some that may have prompted the change to minlines - but I have started to work on this again and I hope this can get into the mainline soon. But if progress slows then I would not object to an immediate change to the syntax file.

[Dragan Simic]

Hello Maxim,

On 2025-03-06 23:45, Maxim Kim wrote:
> It would also need an entry in a doc, right? Like in :h
> g:markdown_minlines

Indeed, and I sent yesterday another patch (as an attachment
to a reply in this thread) that adds a brief description of
the rst_minlines variable to the documentation.

I'm not sure has the patch reached the mailing list yet, though.

[Dragan Simic]

Hello Marshall,

On 2025-03-07 13:21, Marshall Ward wrote:
> Dragan, I have added your patch to the development PR. Thanks very
> much for noting this issue.

Great, thanks a lot!