org-indent-mode documentation suggestion

org-indent-mode documentation suggestion

[Neil Hansen]

[-- Attachment #1: Type: text/plain, Size: 1181 bytes --]

Hello, and thank you for org-mode!

I ran into an issue yesterday when I turned on org-indent-mode and then
tried to disable org-hide-leading-stars. I ended up going on a bit of a
chase to figure out what was going on. I had just switched to a new config,
and thought that might be the problem, so I filed an issue there. It has
some more details if you'd like to take a look:
https://github.com/MatthewZMD/.emacs.d/issues/28

Anyways, the buffer-local variables that org-indent creates made this a
little confusing to figure out. I ended up solving it by
setting org-indent-mode-turns-in-hiding-stars to nil, but that took some
time to figure out because the documentation here suggests that I only
needed to set org-hide-leading-stars to nil:
https://orgmode.org/manual/Clean-view.html

I just wanted to suggest that the documentation be updated to mention the
buffer-local variables and how to work around org-indent's default
behavior. These two lines solved it for me, and I'm sure other star-loving
org users will want the full story on how to set this up properly:

(setq org-hide-leading-stars nil)
(setq org-indent-mode-turns-in-hiding-stars nil)


Thank you again!

Neil

[-- Attachment #2: Type: text/html, Size: 2147 bytes --]

Re: org-indent-mode documentation suggestion

[Bastien]

Hi Neil,

thanks for reporting this - I enhanced the documentation like this:
https://code.orgmode.org/bzg/org-mode/commit/c6a34dc0

Let me know if this solves it for you.

Best,

-- 
 Bastien

Re: org-indent-mode documentation suggestion

[Neil Hansen]

[-- Attachment #1: Type: text/plain, Size: 463 bytes --]

Hi Bastien,

That looks great, thank you for addressing this so quickly. As always, very
impressed with your leadership of the org project.

Looking forward to the next release!

Neil

On Sun., Jan. 26, 2020, 12:00 a.m. Bastien, <bzg@gnu.org> wrote:

> Hi Neil,
>
> thanks for reporting this - I enhanced the documentation like this:
> https://code.orgmode.org/bzg/org-mode/commit/c6a34dc0
>
> Let me know if this solves it for you.
>
> Best,
>
> --
>  Bastien
>

[-- Attachment #2: Type: text/html, Size: 1005 bytes --]

Re: org-indent-mode documentation suggestion

[Bastien]

Hi Neil,

Neil Hansen <neil.hansen.31@gmail.com> writes:

> That looks great, thank you for addressing this so quickly. As
> always, very impressed with your leadership of the org project. 

Well, thanks, but that's just me doing a few contributions after
a looooong time being away.

The true everyday leadership is that of Nicolas and now Kyle.

> Looking forward to the next release!

Org 9.3.2 it is out now, enjoy!

-- 
 Bastien