Please run Python 3k unit tests before commits

[Edward K. Ream]

A common mistake for new committers is to forget to make the code
compatible with Python 3k. The first step before any commit is to run
all the unit tests in unitTest.leo with Python 3k. This will catch
all Py3k syntax errors at the very least.

Edward

[zpcspm]

I just opened http://webpages.charter.net/edreamleo/leo_toc.html and
had a quick look. None of those chapter names seemed to be related to
the issue that you are bringing up. Did you consider to have a
distinct chapter for developers (even if it would be in "Leo’s Users
Guide", not in "Leo’s Developers Guide")? You're crafting leo for
years, I bet you follow a certain workflow instinctively, so you can't
forget it and you know all the gotchas (like reference files, which
new potential contributors can not be aware of or just need a place to
look for until they remember it, like tests that have to be run before
commits, like python 2.x and 3.x compatibility, like the presence of
multiple GUIs, which implies it would be good to run those tests in
both qt and tk to keep them both healthy while tk is still supported).
Some related things to the development of leo itself are in the "How
should I use Leo with bzr/git/hg/svn/cvs?" FAQ entry, this can be
mentioned in the new chapter too. You could as well provide more
details about environments that you are using. For example, I follow
this group for a couple of years and I don't know if you're using
something like virtualenv or not. Actually, I mean I can't remember if
this was ever mentioned here or not. Another example: it's been a
couple of months since I ran leo's tests for the last time (perhaps
because it didn't gave me issues lately, which is good), so I don't
remember anymore how to do it. I know there are some commands for it,
I know there are Alt-Digit bindings for these commands that you
usually mention and I overlook when I read the new posts (because I
pay more attention to keywords and tend to miss details).

My point is: just document your own workflow in a distinct chapter and
let other people follow it step by step.

[Edward K. Ream]

On Wed, Feb 2, 2011 at 9:44 PM, zpcspm <zpc...@gmail.com> wrote:

> Did you consider to have a
> distinct chapter for developers (even if it would be in "Leo’s Users
> Guide", not in "Leo’s Developers Guide")?

Good idea. Would you like to write it? :-) Or suggest topics of
interest to you?

Edward

[zpcspm]

On Feb 22, 4:36 pm, "Edward K. Ream" <edream...@gmail.com> wrote:
> On Wed, Feb 2, 2011 at 9:44 PM, zpcspm <zpc...@gmail.com> wrote:
> > Did you consider to have a
> > distinct chapter for developers (even if it would be in "Leo’s Users
> > Guide", not in "Leo’s Developers Guide")?
>
> Good idea.  Would you like to write it?  :-)

I wonder how could I write about your workflow which I don't know in
details :-) Hence my idea about having a chapter exactly for that. But
I think I understand what you mean. You are basically in the same
situation. While you know your own workflow, because you practice it a
lot and don't have to write it down for reference, you are subjective
in understanding the issues of people who superficially follow leo
(like me) or who are totally new to it. Hence:

> Or suggest topics of interest to you?

I can attempt writing a mini-FAQ that would be developer oriented. I
write the questions, comments for the questions (not answers to the
quesions, because I don't know them!), the FAQ gets reviewed,
completed and you use it as reference for writing the new chapter. So
basically having those questions answered will get us a new chapter
and the FAQ itself will serve as glossary for it.

[Edward K. Ream]

On Wed, Feb 23, 2011 at 1:18 AM, zpcspm <zpc...@gmail.com> wrote:

> I wonder how could I write about your workflow which I don't know in
> details :-)

Ok. I'll put the highlights here, and then we can see how useful they are.

> I can attempt writing a mini-FAQ that would be developer oriented. I
> write the questions, comments for the questions (not answers to the
> quesions, because I don't know them!), the FAQ gets reviewed,

Good idea. Let's do it in this thread.

Edward

[zpcspm]

On Feb 23, 4:48 pm, "Edward K. Ream" <edream...@gmail.com> wrote:
> > I can attempt writing a mini-FAQ that would be developer oriented. I
> > write the questions, comments for the questions (not answers to the
> > quesions, because I don't know them!), the FAQ gets reviewed,
>
> Good idea. Let's do it in this thread.

Here is the mini-FAQ as leo outline. Can't figure out how to attach
the file to my post and I remember google doesn't always play nice
with xml pasted as text, so here's an external link.

http://dl.dropbox.com/u/4226858/dev.leo (5503 bytes)

PS: please let me remind you that English is not my native language,
so the content may be not ideal. Feel free to ask for comments.

[Edward K. Ream]

I am in the midst of clearing old emails: the result will be a list of
action items.

I haven't forgotten this: it is now on the list to be done asap.
Maybe even today.

Edward