Re: [O] Confused about the explanation for 'org-cycle'

2017-10-05 Thread Alain . Cochard
Nicolas Goaziou writes on Thu 28 Sep 2017 23:30: > There are already many ways in Emacs to find a variable. I'm not > convinced that adding such an appendix would be worth the trouble > creating and maintaining it. > As another data point, Emacs' manual doesn't contain an exhaustive >

Re: [O] Confused about the explanation for 'org-cycle'

2017-09-28 Thread Nicolas Goaziou
alain.coch...@unistra.fr writes: > I have a fresh example in mind to illustrate my point: this afternoon, > I was looking for org-blank-before-new-entry. I vaguely remembered it > existed and was searching the manual (from Info) with the regexps > 'blank' and 'list'. Had the variable been

Re: [O] Confused about the explanation for 'org-cycle'

2017-09-28 Thread Josiah Schwab
Hi Alain, > I have a fresh example in mind to illustrate my point: this afternoon, > I was looking for org-blank-before-new-entry. I vaguely remembered it > existed and was searching the manual (from Info) with the regexps > 'blank' and 'list'. Had the variable been mentioned, I would have >

Re: [O] Confused about the explanation for 'org-cycle'

2017-09-28 Thread Alain . Cochard
Thanks for your answer. Nicolas Goaziou writes on Thu 28 Sep 2017 16:31: > > More generally, I cannot remember the number of times when I read > > the manual, do not understand it, > > This is exactly where the manual fails. What is the point of an > exhaustive, yet not understandable,

Re: [O] Confused about the explanation for 'org-cycle'

2017-09-28 Thread Eric S Fraga
On Thursday, 28 Sep 2017 at 12:10, Kyle Meyer wrote: > I don't think maintaining a list of all Org's user options or commands > is a good idea. It is better to point users to commands like > apropos-user-option and apropos-command. Or even "C-h f org- TAB" or "C-h v org- TAB" to see all org

Re: [O] Confused about the explanation for 'org-cycle'

2017-09-28 Thread Kyle Meyer
Robert Horn writes: > Nicolas Goaziou writes: > >> Completeness is not possible. For example, we do not document every >> variable in the manual. Besides, when reading a pile of special rules >> for special cases, the reader may lose focus and miss the whole concept. >> >>

Re: [O] Confused about the explanation for 'org-cycle'

2017-09-28 Thread Robert Horn
Nicolas Goaziou writes: > Completeness is not possible. For example, we do not document every > variable in the manual. Besides, when reading a pile of special rules > for special cases, the reader may lose focus and miss the whole concept. > > BTW, a "docstring" is the documentation you get

Re: [O] Confused about the explanation for 'org-cycle'

2017-09-28 Thread Nicolas Goaziou
Hello, alain.coch...@unistra.fr writes: > As for the wording, I have nothing ecstatic to propose, but -- as a > beginner and trying to think like one who is reading the manual for > the first time while experimenting -- I would have been happy with > something like: > >You can run global

Re: [O] Confused about the explanation for 'org-cycle'

2017-09-26 Thread Alain . Cochard
Nicolas Goaziou writes on Tue 26 Sep 2017 12:41: > Hello, > > alain.coch...@unistra.fr writes: > > > But now, compared to the previous version: > > > >When the cursor is at the beginning of the buffer and the > >first line is not a headline, then actually runs global > >

Re: [O] Confused about the explanation for 'org-cycle'

2017-09-26 Thread Nicolas Goaziou
Hello, alain.coch...@unistra.fr writes: > But now, compared to the previous version: > >When the cursor is at the beginning of the buffer and the first >line is not a headline, then actually runs global cycling > > it is not clear to me why the mention "and the first line is not a >

Re: [O] Confused about the explanation for 'org-cycle'

2017-09-26 Thread Alain . Cochard
Nicolas Goaziou writes on Wed 20 Sep 2017 12:57: > Hello, > > Matt Lundin writes: > [...] > I rewrote the part about `org-cycle-global-at-bob'. Hopefully it is > clearer now. Thank you, Nicolas and Matt, for the feedback. I updated to version org-20170925 and what I

Re: [O] Confused about the explanation for 'org-cycle'

2017-09-20 Thread Nicolas Goaziou
Hello, Matt Lundin writes: > I agree that this is confusing. I examined the org repository history, > and it seems that both the documentation and the variable go all the way > back to 2007. I believe the default value of the variable was changed to > nil, but the

Re: [O] Confused about the explanation for 'org-cycle'

2017-09-18 Thread Matt Lundin
I agree that this is confusing. I examined the org repository history, and it seems that both the documentation and the variable go all the way back to 2007. I believe the default value of the variable was changed to nil, but the documentation was not updated accordingly. Matt

[O] Confused about the explanation for 'org-cycle'

2017-09-18 Thread Alain . Cochard
Hello. In section "2.3.1 Global and local cycling" of the manual I read: `' (`org-cycle') _Subtree cycling_: Rotate current subtree among the states ,-> FOLDED -> CHILDREN -> SUBTREE --. '---' The