Hi, > > I would be glad to receive some feedback regarding the way I > > implemented the > > functions of the base class. > > Is its interface easily understandable (e.g. for implementing other > > RCS connectors)? > > Perhaps the one thing that might not be obvious is the explanation of > ABSOLUTE_LOCATION. Someone reading it won't necessarily know what > self.location or "the base directory" is. But now I'm being really > difficult :-)
I would see three possible solutions here: 1) improving the comments 2) providing "self.location_relative" and "self.location_absolute" 3) making "self.location" always relative to the base directory of the local working copy - but since all RCS except for "git" use absolute paths, this would bloat the code a slightly bit any opinions? > > I am open to suggestion for improvements! > > Not that there is anything wrong with the current patch, but these are > some things I just thought of: > - Let's write the comments with multiline string style comments. This > way epydoc can generate nice documentation for each part of the base > class. (It needs to be below the declared variable - check > translate/lang/common.py for example). > - Should we perhaps check in the base class' __init__ that the required > variables were actually overridden? > - Should we perhaps provide empty update, getcleanfile, and commitfile > methods in the base class? Perhaps a NotImplementedError or something > like that will help developers. These methods are not really optional. These points sound good to me. I will send an improved patch in the evening. regards, Lars ------------------------------------------------------------------------- This SF.net email is sponsored by: Splunk Inc. Still grepping through log files to find problems? Stop. Now Search log events and configuration files using AJAX and a browser. Download your FREE copy of Splunk now >> http://get.splunk.com/ _______________________________________________ Translate-pootle mailing list Translate-pootle@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/translate-pootle
