From: Laura C. <la...@st...> - 2004-05-08 10:17:29
|
In a message of 08 May 2004 12:00:44 +0200, Lele Gaifax writes: >Maybe a little bit out-track, but... > >Probably not in function defs, but it's definitively a good thing to >do, either with a comment or a doc-string, for class/instance >variables. While I see the point of using meaningful var-names, I >cannot think of a viable way of expressing things like "Dictionary >carrying info about each Something around; keyed on .ID, the value is >a tuple blabla...", or the policy used to update it... > >So, whatever style you decide to follow, please *do* encourage >everybody to document their variables of this kind! :-) Sure, but do you ever want to make such a comment _before_ the variable? I never do. Am I atypical? Laura > >ciao, lele. >-- >nickname: Lele Gaifax | Quando vivrò di quello che ho pensato ieri >real: Emanuele Gaifas | comincerò ad aver paura di chi mi copia. >email: le...@se... | -- Fortunato Depero, 1929. >https://lists.sourceforge.net/lists/listinfo/docutils-develop |