On May 10, 10:11 am, "Edward K. Ream" <[email protected]> wrote: > In this thread I shall attempt to explain everything my successor will > need know about Leo in order to carry on after I am gone.
Here is, I think, the last of the general comments about this thread. I wrote it yesterday, along with the start of the docs for leoEditCommands.py, coming soon... As I think about these docs, I remember more things that I remember :-) These kinds of things tend to be fairly general, and fairly vague. Things like, this module has *these* kinds of classes. I also remember the *shape* of classes, roughly how many methods they have, their general organization, whether the classes are simple or quite complex—that kind of thing. I almost never remember actual code, though some code is more “familiar” than others. There may be exceptions to this, but I doubt that that matters. What matters, in the end, is that I can quickly focus on the proper code. So you could say that the purpose of the module-specific docs will be to recreate the things that I *do* remember about a module and its classes. As I write these docs, I expect to remember more about what I remember, and that will lead to more explanation. It's an experiment in writing--I am confident that it will be successful. Important: my intention is to write the documentation after a thorough review of essentially every line of code in each module. I certainly do not want to trust my memory to tell me everything that is noteworthy in Leo's code! I expect that the documentation for each module will start with general remarks about what a module does and what patterns exist for that module that are unique or noteworthy. However, as I start writing the code I am beginning to glimpse an exciting possibility, namely the possibility of organizing the docs based on the outline structure of each module... Later note: I suspect that a few words about overall organization about a module may well be useful, but as I write the docs I think that they will likely be structured as a series of fairly short topics. This will aid in organization and reorganization, and should make the docs a bit less overwhelming. Edward -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/leo-editor?hl=en.
