Editing Editing
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 135: | Line 135: | ||
==Documentation== | ==Documentation== | ||
− | + | We strive for a wiki such that the average user can look at a page's source and understand its general function.<br> | |
+ | In general, a page's source should be documented with comments if it is hard to read and/or understand. This means all code that isn't self-explanatory should be commented. | ||
===Naming Conventions=== | ===Naming Conventions=== | ||
Pages and headings should be named formally, concisely and sensibly. It should convey a general idea of what the section is about. | Pages and headings should be named formally, concisely and sensibly. It should convey a general idea of what the section is about. |