Complete.Org: Mailing Lists: Archives: freeciv-dev: January 2006:
[Freeciv-Dev] Re: rndCiv for freeciv 2.0.99

[Freeciv-Dev] Re: rndCiv for freeciv 2.0.99

[Top] [All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index] [Thread Index]
To: Per Inge Mathisen <per@xxxxxxxxxxx>
Cc: freeciv-dev@xxxxxxxxxxx
Subject: [Freeciv-Dev] Re: rndCiv for freeciv 2.0.99
From: Jason Dorje Short <jdorje@xxxxxxxxxxxx>
Date: Tue, 17 Jan 2006 12:33:00 -0500

Per Inge Mathisen wrote:
We should move [effects documentation] over to the wiki.


I disagree, for the simple reason that there can never be such a thing
as THE effects documentation: the documentation depends on the version
of code used, and the (development version of the) code changes all the
time. I think that the documentation SHOULD be updated whenever there is
a change to the effects code; the version in SVN should never be allowed
to become out of date.

This is a good point. However, experience shows that documentation
included in the repository _does_ get out of sync with the code, fast,
despite many attempts to encourage people to update it. On the other hand,
documentation in the wiki gets updated much more quickly.

The reason is of course that there is a higher expectation of quality and
completeness when something is changed in the repository, which means the
bar for doing a change there is higher.

Although documentation in the repository may not be kept up to date, it is at least possible to keep separate versions. The wiki should not be used for anything crucial to the freeciv package. It may be used for storing a copy of the documentation, which may be helpful in keeping the SVN copies up to date. However the SVN versions should always be the master copy.


[Prev in Thread] Current Thread [Next in Thread]