fpdb/docs/codingstyle.txt

This is just a loose collection of things so far, but might as well make a start :)

A word on wrapping: Please avoid making manual line breaks, the computer can and therefore should do it. Whether people use a phone or a 40" super-uber-HD screen, they should be allowed to use as much of it as they wish/can. Incidentially, if anyone knows how to activate line wrap in Eclipse I'd really appreciate if you let me know.

Comments (or prints) with todo are things that are missing, bugs, or just messy code.
	
After every def (ie. at the end of the method) there should be a comment including the name, e.g.
#def end of parseActionLine

If you don't mind make names in java style, ie.:
Classes, files or tables like this: MyClassName
Methods and variables like this: myMethodName

I'll eventually change all my code to that style, too.

License
=======
Trademarks of third parties have been used under Fair Use or similar laws.

Copyright 2008 Steffen Jobbagy-Felso
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.2 as published by the Free Software Foundation; with
no Invariant Sections, no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license can be found in fdl-1.2.txt

The program itself is licensed under AGPLv3, see agpl-3.0.txt
git1 - initial git commit. note that right now nothing works due to reworking things 2008-08-04 05:44:28 +02:00			`This is just a loose collection of things so far, but might as well make a start :)`

git21 - added fpdb version into db to detect outdated db format. added fields for steals to DB and placeholder inserts to importer. lots of doc updates split pygtk requirements, cleaned table design HTML more noticed its really slow now - might be because I'm running it over LAN. will figure this out shortly 2008-08-10 03:52:05 +02:00			`A word on wrapping: Please avoid making manual line breaks, the computer can and therefore should do it. Whether people use a phone or a 40" super-uber-HD screen, they should be allowed to use as much of it as they wish/can. Incidentially, if anyone knows how to activate line wrap in Eclipse I'd really appreciate if you let me know.`
git1 - initial git commit. note that right now nothing works due to reworking things 2008-08-04 05:44:28 +02:00
			`Comments (or prints) with todo are things that are missing, bugs, or just messy code.`

			`After every def (ie. at the end of the method) there should be a comment including the name, e.g.`
			`#def end of parseActionLine`

			`If you don't mind make names in java style, ie.:`
			`Classes, files or tables like this: MyClassName`
			`Methods and variables like this: myMethodName`

git21 - added fpdb version into db to detect outdated db format. added fields for steals to DB and placeholder inserts to importer. lots of doc updates split pygtk requirements, cleaned table design HTML more noticed its really slow now - might be because I'm running it over LAN. will figure this out shortly 2008-08-10 03:52:05 +02:00			`I'll eventually change all my code to that style, too.`

git1 - initial git commit. note that right now nothing works due to reworking things 2008-08-04 05:44:28 +02:00			`License`
			`=======`
			`Trademarks of third parties have been used under Fair Use or similar laws.`

			`Copyright 2008 Steffen Jobbagy-Felso`
			`Permission is granted to copy, distribute and/or modify this`
			`document under the terms of the GNU Free Documentation License,`
			`Version 1.2 as published by the Free Software Foundation; with`
			`no Invariant Sections, no Front-Cover Texts, and with no Back-Cover`
			`Texts. A copy of the license can be found in fdl-1.2.txt`

			`The program itself is licensed under AGPLv3, see agpl-3.0.txt`