GNU bug report logs - #72523
28.1; rst.el: indentation from TAB key in rst mode (ReST) is wrong when directive as an option

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 72523 in the body.
You can then email your comments to 72523 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: jfbu <jfbu <at> free.fr>
To: bug-gnu-emacs <at> gnu.org
Subject: 28.1; rst.el: indentation from TAB key in rst mode (ReST) is wrong
 when directive as an option
Date: Thu, 8 Aug 2024 14:53:13 +0200

Hi,

I could not find a bug tracker restricted to rst.el (reStructured Text mode). I was told rst.el is now maintained as part of Emacs, not at [Docutils](https://sourceforge.net/projects/docutils/).

Here is my report:

Consider editing in Emacs a file `test.rst` and having typed so far

~~~rest
.. note::
   :name: test
~~~

then insert a blank line and hit the TAB key on next one.  The cursor will align with `test`,  not with `:name:`.

This produces extra space in output when processed either by rst2html or integrated into a Sphinx projet.  For context see [this Sphinx comment](https://github.com/sphinx-doc/sphinx/issues/12742#issuecomment-2275622334).

I am using a file rst.el.gz integrated to my Emacs 28.1 which contains
~~~lisp
;; Maintained by the release process.
(defconst rst-official-version
  (rst-extract-version "%" "OfficialVersion: " "[0-9]+\\(?:\\.[0-9]+\\)+" " "
		       "%OfficialVersion: 1.5.2 %")
  "Official version of the package.")
(defconst rst-official-cvs-rev
  (rst-extract-version "[%$]" "Revision: " "[0-9]+\\(?:\\.[0-9]+\\)+" " "
		       "$Revision: 1.1058.2.9 $")
  "CVS revision of this file in the official version.")
~~~

I tried with electric-indent-mode both on and off.  No change.
Regards,
jfbu

Message #8 received at 72523 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: jfbu <jfbu <at> free.fr>, 72523 <at> debbugs.gnu.org
Cc: Stefan Merten <stefan <at> merten-home.de>
Subject: Re: bug#72523: 28.1; rst.el: indentation from TAB key in rst mode
 (ReST) is wrong when directive as an option
Date: Fri, 9 Aug 2024 09:50:47 +0000

jfbu <jfbu <at> free.fr> writes:

> Hi,
>
> I could not find a bug tracker restricted to rst.el (reStructured Text mode). I was told rst.el is now maintained as part of Emacs, not at [Docutils](https://sourceforge.net/projects/docutils/).
>
> Here is my report:
>
> Consider editing in Emacs a file `test.rst` and having typed so far
>
> ~~~rest
> .. note::
>    :name: test
> ~~~
>
> then insert a blank line and hit the TAB key on next one.  The cursor will align with `test`,  not with `:name:`.
>
> This produces extra space in output when processed either by rst2html or integrated into a Sphinx projet.  For context see [this Sphinx comment](https://github.com/sphinx-doc/sphinx/issues/12742#issuecomment-2275622334).
>
> I am using a file rst.el.gz integrated to my Emacs 28.1 which contains
> ~~~lisp
> ;; Maintained by the release process.
> (defconst rst-official-version
>   (rst-extract-version "%" "OfficialVersion: " "[0-9]+\\(?:\\.[0-9]+\\)+" " "
> 		       "%OfficialVersion: 1.5.2 %")
>   "Official version of the package.")
> (defconst rst-official-cvs-rev
>   (rst-extract-version "[%$]" "Revision: " "[0-9]+\\(?:\\.[0-9]+\\)+" " "
> 		       "$Revision: 1.1058.2.9 $")
>   "CVS revision of this file in the official version.")
> ~~~
>
> I tried with electric-indent-mode both on and off.  No change.
> Regards,
> jfbu

I'm copying in Stefan Merten, in case he has any comments or
suggestions.

Message #11 received at 72523 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: jfbu <jfbu <at> free.fr>, Stefan Merten <stefan <at> merten-home.de>
Cc: 72523 <at> debbugs.gnu.org
Subject: Re: bug#72523: 28.1;
 rst.el: indentation from TAB key in rst mode (ReST) is wrong when
 directive as an option
Date: Sat, 10 Aug 2024 11:06:14 +0300

> From: jfbu <jfbu <at> free.fr>
> Date: Thu, 8 Aug 2024 14:53:13 +0200
> 
> Consider editing in Emacs a file `test.rst` and having typed so far
> 
> ~~~rest
> .. note::
>    :name: test
> ~~~
> 
> then insert a blank line and hit the TAB key on next one.  The cursor will align with `test`,  not with `:name:`.
> 
> This produces extra space in output when processed either by rst2html or integrated into a Sphinx projet.  For context see [this Sphinx comment](https://github.com/sphinx-doc/sphinx/issues/12742#issuecomment-2275622334).
> 
> I am using a file rst.el.gz integrated to my Emacs 28.1 which contains
> ~~~lisp
> ;; Maintained by the release process.
> (defconst rst-official-version
>   (rst-extract-version "%" "OfficialVersion: " "[0-9]+\\(?:\\.[0-9]+\\)+" " "
> 		       "%OfficialVersion: 1.5.2 %")
>   "Official version of the package.")
> (defconst rst-official-cvs-rev
>   (rst-extract-version "[%$]" "Revision: " "[0-9]+\\(?:\\.[0-9]+\\)+" " "
> 		       "$Revision: 1.1058.2.9 $")
>   "CVS revision of this file in the official version.")
> ~~~
> 
> I tried with electric-indent-mode both on and off.  No change.

Stefan, any comments or suggestions?

Message #14 received at 72523 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Merten <stefan <at> merten-home.de>
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: 72523 <at> debbugs.gnu.org, jfbu <jfbu <at> free.fr>
Subject: Re: bug#72523: 28.1;
 rst.el: indentation from TAB key in rst mode (ReST) is wrong when
 directive as an option
Date: Sat, 10 Aug 2024 10:36:40 +0200

Hi!

Yesterday Stefan Kangas wrote:
> jfbu <jfbu <at> free.fr> writes:
> 
>> Hi,
>> 
>> I could not find a bug tracker restricted to rst.el (reStructured Text mode). I was told rst.el is now maintained as part of Emacs, not at [Docutils](https://sourceforge.net/projects/docutils/).
>> 
>> Here is my report:
>> 
>> Consider editing in Emacs a file `test.rst` and having typed so far
>> 
>> ~~~rest
>> .. note::
>>    :name: test
>> ~~~
>> 
>> then insert a blank line and hit the TAB key on next one.  The cursor will align with `test`,  not with `:name:`.

This is not a bug, it's a feature.

You may hit TAB again to jump to the previous alignment point. You may
repeat this to cycle through all alignment points.


						Regards

						Stefan

Message #17 received at 72523 <at> debbugs.gnu.org (full text, mbox):

From: jfbu <jfbu <at> free.fr>
To: Stefan Merten <stefan <at> merten-home.de>
Cc: 72523 <at> debbugs.gnu.org, Stefan Kangas <stefankangas <at> gmail.com>
Subject: Re: bug#72523: 28.1; rst.el: indentation from TAB key in rst mode
 (ReST) is wrong when directive as an option
Date: Sat, 10 Aug 2024 11:41:32 +0200

Hello all,

> Le 10 août 2024 à 10:36, Stefan Merten <stefan <at> merten-home.de> a écrit :
> 
> Hi!
> 
> Yesterday Stefan Kangas wrote:
>> jfbu <jfbu <at> free.fr> writes:
>> 
>>> Hi,
>>> 
>>> I could not find a bug tracker restricted to rst.el (reStructured Text mode). I was told rst.el is now maintained as part of Emacs, not at [Docutils](https://sourceforge.net/projects/docutils/).
>>> 
>>> Here is my report:
>>> 
>>> Consider editing in Emacs a file `test.rst` and having typed so far
>>> 
>>> ~~~rest
>>> .. note::
>>>   :name: test
>>> ~~~
>>> 
>>> then insert a blank line and hit the TAB key on next one.  The cursor will align with `test`,  not with `:name:`.
> 
> This is not a bug, it's a feature.
> 
> You may hit TAB again to jump to the previous alignment point. You may
> repeat this to cycle through all alignment points.
> 

I did completely overlook that feature! Sorry about that...

~~~rest
.. note::
   :class: w
~~~ 

First TAB aligns with w, second one aligns with the "a"
of class and "e" of note and third one is the one a priori
most expected. Fourth one goes back to start of line.

If the alignment points were cycled in reverse order from now,
that would solve my use case ;-)

Best,

Jean-François

> 
> 						Regards
> 
> 						Stefan

Message #22 received at 72523-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: jfbu <jfbu <at> free.fr>
Cc: stefan <at> merten-home.de, 72523-done <at> debbugs.gnu.org, stefankangas <at> gmail.com
Subject: Re: bug#72523: 28.1;
 rst.el: indentation from TAB key in rst mode (ReST) is wrong when
 directive as an option
Date: Thu, 15 Aug 2024 11:34:46 +0300

> Cc: 72523 <at> debbugs.gnu.org, Stefan Kangas <stefankangas <at> gmail.com>
> From: jfbu <jfbu <at> free.fr>
> Date: Sat, 10 Aug 2024 11:41:32 +0200
> 
> Hello all,
> 
> > Le 10 août 2024 à 10:36, Stefan Merten <stefan <at> merten-home.de> a écrit :
> > 
> > Hi!
> > 
> > Yesterday Stefan Kangas wrote:
> >> jfbu <jfbu <at> free.fr> writes:
> >> 
> >>> Hi,
> >>> 
> >>> I could not find a bug tracker restricted to rst.el (reStructured Text mode). I was told rst.el is now maintained as part of Emacs, not at [Docutils](https://sourceforge.net/projects/docutils/).
> >>> 
> >>> Here is my report:
> >>> 
> >>> Consider editing in Emacs a file `test.rst` and having typed so far
> >>> 
> >>> ~~~rest
> >>> .. note::
> >>>   :name: test
> >>> ~~~
> >>> 
> >>> then insert a blank line and hit the TAB key on next one.  The cursor will align with `test`,  not with `:name:`.
> > 
> > This is not a bug, it's a feature.
> > 
> > You may hit TAB again to jump to the previous alignment point. You may
> > repeat this to cycle through all alignment points.
> > 
> 
> I did completely overlook that feature! Sorry about that...
> 
> ~~~rest
> .. note::
>    :class: w
> ~~~ 
> 
> First TAB aligns with w, second one aligns with the "a"
> of class and "e" of note and third one is the one a priori
> most expected. Fourth one goes back to start of line.
> 
> If the alignment points were cycled in reverse order from now,
> that would solve my use case ;-)

Thanks, so I'm now closing this bug.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.