[OSM-dev] Utilities and modules in SVN

Nick Hill nick at nickhill.co.uk
Fri Sep 22 16:00:59 BST 2006


I have been looking through many of the utilities and code snippets in 
the osm SVN repository.

For many pieces of code there, the only indication what the code does is 
the file name. With so little information, the user then needs to read 
through the code and understand it to be able to use it.

If you have written, or intend to write pieces of code for OSM, it would 
be a great help to others who may want to use your code if you write a 
comment section at the top of the file noting the license terms and 
explaining what the code does, and how to use it, including an example 
if appropriate.

If you have written small scripts for OSM, please consider re-visiting 
the code and adding a description of it's function, license conditions 
and instructions, even if very brief.




More information about the dev mailing list