Differences between revisions 8 and 9
Revision 8 as of 2006-09-26 09:16:22
Size: 1311
Editor: 85-125-62-180
Comment:
Revision 9 as of 2008-11-15 14:01:19
Size: 1305
Editor: localhost
Comment: converted to 1.6 markup
Deletions are marked like this. Additions are marked like this.
Line 9: Line 9:
 * Optionally use [http://docutils.sourceforge.net/docs/user/rst/quickref.html ReStructured Text] markup; an example is available in the [wiki:Self:WikiSandBox#head-8dca6975b53d274a0c94033a07763c9651f25a64 WikiSandBox].  * Optionally use [[http://docutils.sourceforge.net/docs/user/rst/quickref.html|ReStructured Text]] markup; an example is available in the [[WikiSandBox#head-8dca6975b53d274a0c94033a07763c9651f25a64|WikiSandBox]].

(when there's no content, it's better to put something in and let others correct it, no?)

Currently there are only few guidelines for creating a page inside Python Wiki:

  • Please structure long pages to sections (learn to use '== headings ==')
  • If you have source code included, run it yourself to test for at least simple errors
  • Avoid duplicating information when not necessary, and respect copyrights. If you are unsure, at least credit the source, so that others can fix things if needed
  • Learn to use wiki format => HelpOnFormatting. It allows for more consistent page styles

  • Optionally use ReStructured Text markup; an example is available in the WikiSandBox.

  • Take advantage of this wiki's ability to markup Python language - it is easier to read than simple, plain monotype font. An example:
       1 from hello import world
       2 
       3 def say_hello():
       4     """Just say hello :)"""
       5     what = world()
       6     message = what.greet()  # no, there's no module named "hello" 
       7                             # in Python stdlib - at least not yet :)
       8     return message
       9 
      10 if __name__ == "__main__":
      11     say_hello()
    
    Yeah, this is a stub only...

WikiGuidelines (last edited 2013-11-14 18:29:01 by PaulBoddie)

Unable to edit the page? See the FrontPage for instructions.