On 29/05/2013 00:29, Terry Jan Reedy wrote:
On 5/28/2013 3:39 PM, Antoine Pitrou wrote:
On Tue, 28 May 2013 15:06:39 -0400 Terry Reedy
wrote: Yes, Nick suggested README instead of what I had. I want a prefix to keep it near the top of a directory listing even when other non 'test_xxx' files are added. I thing '_' wold be better though.
I don't think "prefixing with a weird character
'_' is not weird for Python names.
so that the filename show up top" is a very elegant trick,
I disagree. Books have Table of Contents, Preface, and Foreword sections at the front for a reason: if they are present, they are easy and obvious to find. READMEs are like a preface*, sometimes with an annotated Contents. They logically belong at the top for the same reason.
A long title for this how-to file, which I would prefer, would be something like "_Writing-Testing-Running_Idle_Tests", or "_Idle_Test-Writing_Guidelines", or "A_Guide_to_Idle_Tests", or "An_Idle_Test_HOWTO".
[snip] I'm somehow not happy about "_README", what with a single underscore indicating "internal" in Python code. Perhaps it would be a bit more Pythonic to have "_README_" instead (dunder would be overdoing it, perhaps). :-)