org-hide-emphasis-markers not mentioned in the org manual

org-hide-emphasis-markers not mentioned in the org manual

[Thomas Rikl]

(and perhaps other customization variables)

Version: Release 9.1.2 (release 9.1.2-192-gc029c4)
of the org manual

regards Thomas R.

Re: org-hide-emphasis-markers not mentioned in the org manual

[Alain.Cochard]

Thomas Rikl writes on Tue 14 Nov 2017 14:10:

 > (and perhaps other customization variables)
 > 
 > Version: Release 9.1.2 (release 9.1.2-192-gc029c4)
 > of the org manual
 > 
 > regards Thomas R.

In a recent (late sept.)  discussion on this list ("Confused about the
explanation for 'org-cycle"), it was argued by Org experts that
documenting every customization variable was not the best way to go.
So maybe this also applies for the particular case of
org-hide-emphasis-markers...

Regards


-- 
EOST (École et Observatoire des Sciences de la Terre) 
IPG (Institut de Physique du Globe) | alain.cochard@unistra.fr
5 rue René Descartes   [bureau 106] | Phone: +33 (0)3 68 85 50 44 
F-67084 Strasbourg Cedex, France    | Fax:   +33 (0)3 68 85 01 25     

Re: org-hide-emphasis-markers not mentioned in the org manual

[Nick Dokos]

Alain.Cochard@unistra.fr writes:

> Thomas Rikl writes on Tue 14 Nov 2017 14:10:
>
>  > (and perhaps other customization variables)
>  > 
>  > Version: Release 9.1.2 (release 9.1.2-192-gc029c4)
>  > of the org manual
>  > 
>  > regards Thomas R.
>
> In a recent (late sept.)  discussion on this list ("Confused about the
> explanation for 'org-cycle"), it was argued by Org experts that
> documenting every customization variable was not the best way to go.

That's not quite right: it should say

" ... documenting every customization variable *in the manual* was not
the best way to go."

*All* customization variables should be documented. You can get that documentation
with

    C-h v <variable name> RET

If there is no such documentation, that's a bug. You can also use "customize" to
list such variables (or groups of related variables).

The manual is a good way to start, but it does noe wander into the darker corners.
Fortunately, emacs provides enough flash lights to illuminate them. Knowing about
these is important: it makes your (emacs) life easier, more productive and more
enjoyable.

> So maybe this also applies for the particular case of
> org-hide-emphasis-markers...
>
> Regards

-- 
Nick