<[email protected]> 于2018年10月11日周四 上午7:01写道:
>
....
>
> I recently went through all the settings in Leo, and wow, there's quite a bit 
> of good stuff there. How much of that is in the docs? Had I not decided to 
> look at *all* the settings, I would not have discovered many of them. I'd 
> like a page that lists all the settings, with descriptions. Many @settings 
> nodes have descriptions, and many others do not, so I have little idea as to 
> what they do. Part of the documentation effort should be to put a good 
> description of each one. Is Leo "aware" of all its settings? Is it not 
> possible then to have a script that will generate documentation for all Leo's 
> settings as an HTML (or part of the docs' rst) - and make sure this is on the 
> web site. Trust me, it would make Leo a lot more useable if people had a page 
> where they could see all the settings and just search for what they want.
>

Sayeahooo... me 2,
but doc and code, is different mind working, code good not means doc. good,
so, i agree MyLeoSettings.leo style:
- self explain
- explain on the spot
- of course: no need explain is best ~ need the naming skill for every
setup item or variable name ...

....
> I want to add support for a new language (syntax highlighting, etc). How well 
> is this documented? Does it just say to look at the source code?
>
> Are all the default keybindings documented?
>
> Leo is almost tragic in how powerful it is, and how much its adoption is held 
> back by poor documentation. Good documentation will be a major endeavour, but 
> well worth it.
>

Yes, i meet same problems,
but the reason is simple:
- Leo release so many years, but the core developer always only EKR
- so means more and more knowledge for EKR as natural truth, not need explain
- and servicing big document.leo project is not funny and tired...

so how to fix it? anlifer is right:
- for EKR, just augment all docstrings in every source code
- for Leo community, need running one document team, build friendly
document for Leo

of course...the 2nd way, need EKR inti.


> On Wednesday, October 10, 2018 at 12:10:38 PM UTC-7, Edward K. Ream wrote:
>>
>> On Wed, Oct 10, 2018 at 1:22 PM <[email protected]> wrote:
>>
>> > My dream is that the documents be vastly improved.
>>
>> Please tell me what you think should be added to CheatSheet.leo, or to the 
>> tutorials.
>>
>> Typing completion in the minibuffer is a good way to discover commands.
>>
>> After that, leoPyRef.leo contains all the answers.
>>
>> Edward
>
> --
> You received this message because you are subscribed to the Google Groups 
> "leo-editor" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to [email protected].
> To post to this group, send email to [email protected].
> Visit this group at https://groups.google.com/group/leo-editor.
> For more options, visit https://groups.google.com/d/optout.



-- 
life is pathetic, go Pythonic! 人生苦短, Python当歌!
俺: http://zoomquiet.io
授: http://creativecommons.org/licenses/by-sa/2.5/cn/
怒: 冗余不做,日子甭过!备份不做,十恶不赦!
KM keep growing environment culture which promoting organization learning!

-- 
You received this message because you are subscribed to the Google Groups 
"leo-editor" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/leo-editor.
For more options, visit https://groups.google.com/d/optout.

Reply via email to