From b20f740d30a36ac51dbe38e4bf90a3fe809cf54a Mon Sep 17 00:00:00 2001
From: Martin Stubenschrott <stubenschrott@gmx.net>
Date: Sat, 3 Jan 2009 14:45:49 +0100
Subject: [PATCH] added simple style guide in HACKING file

---
 HACKING                 | 26 ++++++++++++++++++++++++++
 common/content/hints.js |  7 +++++--
 2 files changed, 31 insertions(+), 2 deletions(-)
 create mode 100644 HACKING

diff --git a/HACKING b/HACKING
new file mode 100644
index 00000000..a1997275
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,26 @@
+== Coding Style ==
+In gerneral: Just look at other source code!
+We try to be quite consistent, but of course, that's not always possible.
+
+=== The most important style issues are: ===
+* Use 4 spaces to indent things, no tabs, not 2, nor 8 spaces. If you use vim,
+  this should be taken care of automatically by the modeline.
+
+* Use " for enclosing strings instead of ', unless using ' avoids escaping of lots of "
+  Example: alert("foo") instead of alert('foo');
+
+* Exactly one space after if/for/while/etc. and after a comma, but none after a parenthesis
+  or after a function call:
+      for (pre, contition, post)
+  but:
+      alert("bla");
+
+* Opening curly brackets { must be on a new line, unless it is used in a closure:
+      myFunction ()
+      {
+          return;
+      }
+  but:
+      setTimeout(function () {
+          ...
+      });
diff --git a/common/content/hints.js b/common/content/hints.js
index dd8d001f..cdc90dfb 100644
--- a/common/content/hints.js
+++ b/common/content/hints.js
@@ -83,18 +83,21 @@ function Hints() //{{{
         Y: Mode("Yank hint description",               function (elem) util.copyToClipboard(elem.textContent || "", true),    extended)
     };
 
-    // Implement ';F' hint sequences. This function handles on element of the hint sequence.
+    // Used to open multiple hints
     function hintSequenceElement(elem)
     {
         // Want to always open sequence hints in background
         // (remember: NEW_BACKGROUND_TAB and NEW_TAB semantics assume
         //            that loadInBackground=true)
-        if( options.getPref("browser.tabs.loadInBackground") )
+        if (options.getPref("browser.tabs.loadInBackground"))
             buffer.followLink(elem, liberator.NEW_BACKGROUND_TAB);
         else
             buffer.followLink(elem, liberator.NEW_TAB);
 
         // Move to next element in sequence
+        // TODO: Maybe we find a *simple* way to keep the hints displayed rather than 
+        // showing them again, or is this short flash actually needed as a "usability
+        // feature"? --mst
         hints.show("F");
     }