From b99daffe6b335d20de3ba5876d5a2894029f8643 Mon Sep 17 00:00:00 2001 From: R0b0t1 Date: Sun, 13 Jun 2010 16:37:41 -0500 Subject: [PATCH] Undid and more on TODO. --- Doc/sphinx/TODO | 16 ++++++++++++++-- Doc/sphinx/whysimba.rst | 11 ++++++----- 2 files changed, 20 insertions(+), 7 deletions(-) diff --git a/Doc/sphinx/TODO b/Doc/sphinx/TODO index 6faf1c0..7c3e6d5 100644 --- a/Doc/sphinx/TODO +++ b/Doc/sphinx/TODO @@ -1,9 +1,21 @@ # Change a minus to a plus when something is being worked on. # Remove it when you are done. -- Run spellcheck before you commit. -- Remove small/extraneous pages (merge them as a section with another). +# GENERAL + +- Run spellcheck before you commit (make sure you ignore section names + and the like). +- Remove small/extraneous pages (merge them as a section with another or + mark that you will add stuff to them). - Create some conventions. Capitalize Simba whenever it occurs, and pick either color or colour (it'd probably be best to use color, as the code seems to use it). - Find stuff to add to this list. + +# ADDING CONTENT + +- Expand "Troubleshooting" + - And its subsection. +- Expand "Feature Overview" + - And its subs. There's like nothing in them, those are the type + of pages I was talking about. Combine them under feature overview? diff --git a/Doc/sphinx/whysimba.rst b/Doc/sphinx/whysimba.rst index 1c95822..6f22ff6 100644 --- a/Doc/sphinx/whysimba.rst +++ b/Doc/sphinx/whysimba.rst @@ -1,4 +1,4 @@ -.. _whimsical: +.. _whysimba: Why Simba? ========== @@ -49,7 +49,7 @@ However this does not guarantee a bug free program. (Bug free programs don't exist) Should you encouter a bug, please consider sending a bug report so we can -resolve the issue: :ref:`bug report`. +resolve the issue: :ref:`bugreport`. Cross Platform ~~~~~~~~~~~~~~ @@ -70,6 +70,7 @@ Fast ~~~~ The Simba developers have designed and written Simba with speed in mind. -However, some speed was sacrificed for readability and maintainability, -regardless, Simba is still quite fast. - +It is important to understand, however, that premature optimization usually +ends up hurting development by introducing bugs and other forms of +instability. Simba attempts to find a middle-ground and has sacrificed some +speed for readability and maintainability, but is overall still quite fast.