summaryrefslogtreecommitdiffstats
path: root/docs/UXP Coding Style.md
diff options
context:
space:
mode:
authorwolfbeast <mcwerewolf@wolfbeast.com>2020-03-10 12:47:03 +0100
committerwolfbeast <mcwerewolf@wolfbeast.com>2020-03-10 12:47:03 +0100
commitfda8403f562657ec7ae340d8553e462592a30630 (patch)
treedddd3b1973328fd97c3f19ebee062ca2059ba0c8 /docs/UXP Coding Style.md
parentbe415c44c7237c24718da974bcaa58985fc92fc5 (diff)
downloadUXP-fda8403f562657ec7ae340d8553e462592a30630.tar
UXP-fda8403f562657ec7ae340d8553e462592a30630.tar.gz
UXP-fda8403f562657ec7ae340d8553e462592a30630.tar.lz
UXP-fda8403f562657ec7ae340d8553e462592a30630.tar.xz
UXP-fda8403f562657ec7ae340d8553e462592a30630.zip
Minor update to UXP coding style guideline.
Diffstat (limited to 'docs/UXP Coding Style.md')
-rw-r--r--docs/UXP Coding Style.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/UXP Coding Style.md b/docs/UXP Coding Style.md
index 77a50e0f1..5dc4fd2a5 100644
--- a/docs/UXP Coding Style.md
+++ b/docs/UXP Coding Style.md
@@ -425,8 +425,9 @@ try {
If statements on a single line become overly long, they should be split into multiple lines:
- Binary operators (including ternary) must be left on their original lines if the line break happens around the operator. The second line should start in the same column as the start of the expression in the first line.
- Lists of variables (e.g. when calling or declaring a function) should be split at the wrapping column.
-- Long OOP calls should be split at the period with the period on the start of the new line, indented to the column of the first object, filling to the wrapping column where possible.
+- Long OOP calls should be split at the period with the period on the start of the new line, indented to the column of the first object, filling to the wrapping column where possible, including additional terms.
- When breaking assignments/operations/logic, break right after the operator (`=`, `+`, `&&`, `||`, etc.)
+- **Don't break too rigorously**; short additions should be kept on the same line to keep things legible - use common sense and context for flexibility.
WRONG:
```JavaScript
@@ -471,5 +472,10 @@ let sessionStartup = Cc["@mozilla.org/browser/sessionstartup;1"]
## XUL and other XML-derivatives
Applies to `*.xul`, `*.html`, `*.xhtml`.
+TODO
## IDL
Applies to `*.idl`, `*.xpidl` and `*.webidl`.
+TODO
+## Python-esque
+Applies to `*.py`, `mozbuild` etc.
+TODO