more on maildir modification times!
nicolas.s-dev at laposte.net
Wed Mar 25 19:39:44 GMT 2015
On Wed, Mar 25, 2015 at 07:40:28PM +0100, Abdó Roig-Maranges wrote:
> I agree more documentation on the internals would be useful.
> Not sure about the website though (which is very nice BTW). In my experience,
> documentation about the internals is most useful when found next to the code you
> are modifying, in docstrings or comments.
Yes, this is true most of the time.
But some general documentations are hard to put into the sources because
there is no obvious place where it should stand. Consequently, important
documentation such as the implementation designs aren't documented at
This is currently the case with the date/times thing. There is no
obvious file where to put it in the source code. Any developer might
have to care about that and find the relevant doc without hard
researches in the sources.
...If he even think that this could be documented somewhere. Most of the
time, contributors will just jump into the code the hard way. If we
could point to a uniq documentation database, contributing would mean
read these pages to get a global overview about the logics, etc... and
next jump into the code while already knowing everything that worth.
Also, the website sources are text files, designed to stand within the
offlineimap.git repository (in ./website). The documentation on how to
do that is already out. ,-)
So, having this kind of documentation in a sub-directory should not hurt much.
> Anyway, when I get some time I'll try to contribute with some documentation.
More information about the OfflineIMAP-project